# get_clanker_instructions

`tools/call` · `POST /clanker/v1/clanker-instructions:get`

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.

- Area: Planning
- Needs the read grant. Read-only. Idempotent.

## Inputs

- `status` (string): 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.
- `kind` (string, one of: `ticket`, `test-cases`, `test-code`, `fixtures`, `test-ci`): 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.
- `team` (string): The team the work belongs to, such as WEB. Leave it out for the workspace's instructions or template statuses.

## Request

```json
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "get_clanker_instructions",
    "arguments": {
      "status": "Plan",
      "team": "WEB"
    }
  }
}
```

## HTTP request

The same call over the clanker HTTP API, with a clanker OAuth access token:

```bash
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"
  }'
```