For AI agents: a documentation index is available at /llms.txt. A markdown version of this page is available at /guide/mcp/quickstart.md.
Quickstart
Verify your key, connect a client, and make your first assistant-driven Orangescrum call.
About five minutes, assuming you already have a partner API key.
Verify the server sees your key
Run this from the machine that will host your AI client. A successful response lists all 15 tool names.
curl -sS -X POST https://v4-api.orangescrum.com/mcp/partner \ -H 'Content-Type: application/json' \ -H 'X-API-KEY: YOUR_KEY' \ -d '{"jsonrpc":"2.0","method":"tools/list","id":1}'A
401means the key is wrong, missing or expired. Nothing else will work until this call succeeds, so fix it here rather than in a client config.Add the server to your client
Drop the snippet for your client into its config file. Claude Desktop needs Node.js installed, because it bridges to the remote server through
npx mcp-remote; the others speak remote MCP natively.See Client setup for all four, or use the Claude Desktop one below to get going:
{ "mcpServers": { "orangescrum": { "command": "npx", "args": [ "-y", "mcp-remote@latest", "https://v4-api.orangescrum.com/mcp/partner", "--header", "X-API-KEY:YOUR_KEY" ] } } }Restart the assistant
MCP configs are read at startup. Fully quit and relaunch โ reloading the window is not enough for most clients.
Confirm the tools appeared
Ask the assistant what Orangescrum tools it has. It should list tools for projects, tasks, timelogs and users. If it says it has none, jump to Troubleshooting.
Try a real request
Start with a read so you can see the shape of the data before anything writes:
List my Orangescrum projects and tell me which ones have tasks due this week.
Then try a write once you are comfortable:
Create a task in Website Redesign called "Audit meta descriptions", assign it to me, and set the due date to next Friday.
#Useful first prompts
"What's overdue across my projects, grouped by assignee?"
"Run the daily_standup prompt for the Website Redesign project."
"Log 2 hours against OS-431 for yesterday with the note 'schema migration'."
"Which tasks in this sprint have no assignee or no estimate?"
Check writes before you trust them
Assistants can misread which project or task you meant, especially when names are similar. For the first few sessions, confirm each write in Orangescrum before moving on โ and keep the key read-only until you have.