Search the docs

Search guides, API endpoints and MCP tools.

Screens

open_plan_file

Hosts show it as Plan file.

Read grantRead-onlyIdempotent

Open a local .plan.md file in the plan viewer, with the ticket its name gives, such as WEB-31.plan.md. Codex opens it when the person opens such a file. Returns the file and its ticket, or null when the name gives no ticket you can open. Needs read access.

Inputs

fileobjectRequired

The local file the host opened.

tools/callJSON-RPC
{  "jsonrpc": "2.0",  "id": 1,  "method": "tools/call",  "params": {    "name": "open_plan_file",    "arguments": {      "file": {        "name": "WEB-31.plan.md",        "resourceUri": "file:///Users/maya/code/storefront/WEB-31.plan.md"      }    }  }}
POST/agent/v1/plan-files:open
curl -X POST https://api.qa.clankership.net/agent/v1/plan-files:open \  -H "Authorization: Bearer $CLANKER_AGENT_TOKEN" \  -H "Content-Type: application/json" \  -d '{    "file": {      "name": "WEB-31.plan.md",      "resourceUri": "file:///Users/maya/code/storefront/WEB-31.plan.md"    }  }'
The same call over the agent HTTP API. Set CLANKER_AGENT_TOKEN to an agent OAuth access token.