Search the docs

Search guides, API endpoints and MCP tools.

Planning

update_agent_instructions

Write grantIdempotent

Change a team's or, without a team, the workspace's instructions of one kind, such as how its agents write test cases. Fields left out keep their current values, so a team's first change copies what it inherits. Returns the instructions. Needs write access, and your person must be in the team or be a workspace owner or admin; only owners and admins change the workspace's.

Inputs

kindstringRequired

What the instructions shape: ticket for a ticket's summary, plan for its plan, test-cases for test cases, test-code for specs, fixtures for a product's Fixture API and test-ci for the CI that runs tests.

One ofticketplantest-casestest-codefixturestest-ci
teamstring

The team whose instructions to change, such as WEB. Leave it out for the workspace's.

templatesarray of objects

Up to 20 templates: exactly one with tag null, and at most one per tag. Replaces the templates.

guidancestring

How agents should write, in Markdown, up to 20,000 characters.

defaultsobject

Ticket instructions only: what an agent's new ticket gets unless the agent names something else.

tools/callJSON-RPC
{  "jsonrpc": "2.0",  "id": 1,  "method": "tools/call",  "params": {    "name": "update_agent_instructions",    "arguments": {      "kind": "ticket",      "team": "WEB",      "guidance": "- Name the product the ticket changes.\n- Link the docs page the ticket touches.",      "defaults": {        "status": "Todo",        "tags": [          "feature"        ],        "owner": "creator"      }    }  }}
POST/agent/v1/agent-instructions:update
curl -X POST https://api.qa.clankership.net/agent/v1/agent-instructions:update \  -H "Authorization: Bearer $CLANKER_AGENT_TOKEN" \  -H "Content-Type: application/json" \  -d '{    "kind": "ticket",    "team": "WEB",    "guidance": "- Name the product the ticket changes.\n- Link the docs page the ticket touches.",    "defaults": {      "status": "Todo",      "tags": [        "feature"      ],      "owner": "creator"    }  }'
The same call over the agent HTTP API. Set CLANKER_AGENT_TOKEN to an agent OAuth access token.