Skip to main content

MCP server

Windrunner exposes a Model Context Protocol server for AI clients that need to read workspace information or update project work.

Endpoint and transport

SettingValue
URLhttp://localhost:8066/mcp
TransportStreamable HTTP (stateless)
AuthAuthorization: Bearer <API key> — same keys as the REST API

Enable/disable with WINDRUNNER_MCP_ENABLED (true by default).

Connect a client

Codex CLI:

Terminal
codex mcp add windrunner \
--url http://localhost:8066/mcp \
--header "Authorization: Bearer wr_k_..."

Claude Desktop (claude_desktop_config.json):

{
"mcpServers": {
"windrunner": {
"type": "http",
"url": "http://localhost:8066/mcp",
"headers": {
"Authorization": "Bearer wr_k_..."
}
}
}
}

Available tools

Read tools:

ToolScope requiredDescription
list_projectsprojects:readA bounded, paginated page of projects visible to the key owner
list_teamsteams:readBounded team candidates, optionally filtered by query
get_teamteams:readOne team's name and description
list_team_membersteam_members:readA bounded, paginated team-member page with title, bio, and role
list_team_projectsteam_projects:readA bounded, paginated page of projects linked to a team
list_usersusers:readBounded active-user candidates, optionally filtered by query
get_userusers:readOne active user's identity, title, and bio
search_work_itemswork_items:readSearch a project's work items, entries, and relationship reasons
list_work_itemswork_items:readA bounded, paginated work-item page for a project
get_work_itemwork_items:read + entries:read + relationships:readOne selected item plus the first bounded pages of entries and relationships
list_entriesentries:readA bounded, paginated entry page for a project or work item
list_relationshipsrelationships:readA bounded, paginated relationship page for a project or entity
list_project_blockerswork_items:read + relationships:readServer-side blocker results with bounded pagination
get_project_summaryprojects:read + work_items:read + entries:read + relationships:readServer-side project totals and distributions
list_my_work(any valid key)A bounded, paginated page of items assigned to the key owner

Write tools:

ToolScope requiredDescription
add_entryentries:writeAdd a comment, finding, answer, or evidence to an item
update_work_item_statuswork_items:writeChange only the status of an item
create_work_itemwork_items:writeCreate a NOTE, TASK, QUESTION, APPROVAL, REVIEW, or DECISION
link_relationshiprelationships:writeCreate a typed link such as BLOCKED_BY between two items

Progressive reads

Start with a list or search tool to identify the relevant team, user, project, or work item. Candidate lists and collection tools return bounded results; collection responses include total and hasMore where pagination applies. Fetch another page only when the question requires it, then use a targeted detail tool for the selected ID.

Project summaries and blocker results are aggregated on the server, so they do not require loading every work item or entry into the model. This keeps MCP usage aligned with the same progressive-fetch behavior used by Ask AI.

Safety

  • Every action is attributed to the API-key owner in the audit log.
  • Writes trigger the same notifications as human actions.
  • Project-level authorization still applies: a key can only see and modify projects its owner can.
  • Agents should search for an existing matching work item, entry, or relationship before creating one. A clear match should be reported or updated rather than duplicated; ambiguous matches should be clarified.
  • No delete tools are exposed.