Search the docs

Search guides, API endpoints and MCP tools.

Planning

get_clanker_instructions

Read grantRead-onlyIdempotent

Get the instructions to follow. With status: what that status of the team asks of you, before you work a ticket in it: its document's name and template, its guidance, which says how to work it and when to move on, and its checklist template. With kind: the instructions no status holds, the defaults a new ticket gets (ticket), test cases (test-cases), specs (test-code), a product's Fixture API (fixtures) or the CI that runs tests (test-ci), with source saying whether they are the team's, the workspace's or Clanker Ship's. Give status or kind, not both. Needs read access.

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
teamstring

The team the work belongs to, such as WEB. Leave it out for the workspace's instructions or template statuses.

tools/callJSON-RPC
{  "jsonrpc": "2.0",  "id": 1,  "method": "tools/call",  "params": {    "name": "get_clanker_instructions",    "arguments": {      "status": "Plan",      "team": "WEB"    }  }}
POST/clanker/v1/clanker-instructions:get
curl -X POST https://api.clankership.com/clanker/v1/clanker-instructions:get \  -H "Authorization: Bearer $CLANKER_TOKEN" \  -H "Content-Type: application/json" \  -d '{    "status": "Plan",    "team": "WEB"  }'
The same call over the clanker HTTP API. Set CLANKER_TOKEN to a clanker OAuth access token.