Search the docs

Search guides, API endpoints and MCP tools.

Planning

update_clanker_instructions

Write grantIdempotent

Change instructions. With status: that status's document name, template or guidance. With kind: a team's or, without a team, the workspace's instructions of that kind, such as how its clankers write test cases; a team's first change copies what it inherits. Fields left out keep their current values. Give status or kind, not both. 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

statusstring

A status name of the team, such as Plan, for what that status asks of you: its document's name and template, its guidance, and its checklist.

kindstring

Instructions no status holds: ticket for the defaults a clanker's new ticket gets, 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 oftickettest-casestest-codefixturestest-ci
documentnullable string

With status: the name of its document, up to 40 characters, such as Design; null for no document.

templatestring

With status: the Markdown its document starts from, up to 20,000 characters.

teamstring

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

templatesarray of objects

With a test kind: up to 20 templates, exactly one with tag null and at most one per tag. Replaces the templates.

guidancestring

How clankers should work, in Markdown, up to 20,000 characters: with status, how to work the status; with a test kind, how to write.

defaultsobject

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

tools/callJSON-RPC
{  "jsonrpc": "2.0",  "id": 1,  "method": "tools/call",  "params": {    "name": "update_clanker_instructions",    "arguments": {      "status": "Backlog",      "team": "WEB",      "guidance": "- Name the product the ticket changes.\n- Reproduce a bug before filing it, and add its steps to the Scope."    }  }}
POST/clanker/v1/clanker-instructions:update
curl -X POST https://api.clankership.com/clanker/v1/clanker-instructions:update \  -H "Authorization: Bearer $CLANKER_TOKEN" \  -H "Content-Type: application/json" \  -d '{    "status": "Backlog",    "team": "WEB",    "guidance": "- Name the product the ticket changes.\n- Reproduce a bug before filing it, and add its steps to the Scope."  }'
The same call over the clanker HTTP API. Set CLANKER_TOKEN to a clanker OAuth access token.