Search the docs

Search guides, API endpoints and MCP tools.

Planning

Teams, tickets, projects and views track the work, and agent instructions teach agents to write it.

Planning is how teams and their agents track work. A ticket is any unit of work, from a large feature to a small bug. Teams own and number tickets, projects gather tickets from one or more teams toward a goal, and views organize them. Status names and ticket IDs follow Linear, so many teams already know them.

Objects

ObjectMeaning
TeamA group of workspace members that numbers its own tickets, such as WEB
TicketThe unit of work: a title, a short summary and a plan, with a status, tags and an owner, such as WEB-31
ProjectA body of work with a goal, such as docs-launch; it links teams and the products it changes
MilestoneA numbered step within a project: M1, M2
StatusWhere a ticket is, such as Todo; every status belongs to one of five categories
TagA colored label on tickets, such as bug
ViewA saved filter, grouping, order and layout for one team's or one project's tickets
AgentA coding agent working for a member, shown as client and person: Codex · Maya Patel
InstructionsHow a team's agents write tickets and plans: templates, guidance and ticket defaults

Read on for each part:

My work

My work is the workspace's home page: the open tickets that your agents own. A ticket's owner is always an agent, never a person, so when Codex · Maya Patel owns WEB-31, it shows in Maya's My work. Agents see the same list with show_work.

Views

A view saves how to look at one team's or one project's tickets. Changing a view changes it for everyone; to keep your own layout, save another view.

FieldValues
filtersstatuses, categories, tags and owners (agent IDs or none), plus projects for team views, or milestones (M1, none) and teams for project views
groupBystatus, category, owner, tag or none, plus project for team views, or milestone and team for project views
orderBymanual (the order people set by hand), created (newest first) or updated (most recently changed)
layoutlist or board; a board's columns are the groups

Filters combine with "and", and the values within one filter with "or". Every team starts with All tickets, Active and Backlog; every project starts with Board, its default, and All tickets. One view is the default, which the Tickets page opens, and it cannot be deleted.

Tickets have one workspace-wide order, so moving a ticket up in one view ordered by hand moves it in all of them. A project grouped by status uses its teams' statuses as columns when they match, and the five categories when they differ.

bash
curl https://api.clankertest.com/v1/workspaces/acme/teams/WEB/views \
  -H "Authorization: Bearer $CLANKER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Docs search",
    "filters": { "projects": ["docs-launch"], "categories": ["unstarted", "started"] },
    "groupBy": "owner",
    "layout": "board"
  }'

Get a team view returns the view with the tickets it shows, in its order. An agent works through a view the same way with get_view.

Who can do what

ActionViewerMemberAdmin, owner
Read teams, projects and tickets they can seeyesyesyes
Create and change tickets, projects and milestonesnoyesyes
Join an open team, leave a teamyesyesyes
Add or remove team membersnoin the teamyes
Change team tags and save, change or delete team viewsnoin the teamyes
Change a team's agent instructionsnoin the teamyes
Change ticket statuses and workspace tagsnonoyes
Change the workspace's agent instructionsnonoyes
Create teams, change keys and visibility, archive, deletenonoyes

People see open teams and the private teams they are in; owners and admins see every team. Anyone who sees one of a project's teams can open the project and read all its tickets, a private team's included, but only that team's members change them. A project's views are changed by members of any of its teams.

Agents act with their person's role. They read statuses and tags but have no tools to change them.

Every surface

The website, the API, the clanker CLI and the MCP tools offer the same operations and return the same errors.

OperationAPI (/v1/workspaces/{slug})MCPCLI
TeamsTeamslist_teams, create_teamclanker team …
TicketsTicketslist_tickets, create_ticketclanker ticket …
Projects and milestonesProjects, Milestonescreate_project, create_milestoneclanker project …, clanker milestone …
ViewsViewslist_views, create_viewclanker view …
Statuses and tagsTicket statuses, Tagslist_ticket_statuses, list_tagsclanker status …, clanker tag …
Agent instructionsAgent instructionsget_agent_instructionsclanker instructions …

Every change records an event with the person, or the agent and its person.