For AI agents: a documentation index is available at /llms.txt. A markdown version of this page is available at /guide/mcp/tools.md.
Tools
All 74 MCP tools, grouped by domain, with the OAuth scope each one needs.
The server advertises 74 tools across ten domains. Each one asserts a scope before it runs, so what your assistant can actually do is decided at consent time, not by this list.
Ask the server, not this page
Tool names are part of the server's contract and can change between
deployments. The authoritative list for the endpoint you are pointed at always
comes from a tools/list call, or just ask your assistant: "what Orangescrum
tools do you have?"
#Coverage
| Domain | Tools | Read scope | Write scope |
|---|---|---|---|
| Test management | 21 | mcp:tests.read | mcp:tests.write |
| Checklists | 20 | mcp:checklists.read | mcp:checklists.write |
| Tasks | 8 | mcp:tasks.read | mcp:tasks.write |
| Sprints | 7 | mcp:sprints.read | mcp:sprints.write |
| Projects | 5 | mcp:projects.read | mcp:projects.write |
| Backlog hierarchy | 4 | n/a | mcp:epics.write |
| Timelogs | 3 | mcp:timelogs.read | mcp:timelogs.write |
| Users | 3 | mcp:users.read | n/a |
| Project context | 2 | mcp:context.read | mcp:context.write |
| Document search | 1 | mcp:documents.read | n/a |
#Projects
Addressable by numeric id or uniq_id; both come back in every result.
| Tool | Scope | What it does |
|---|---|---|
list_projects | read | List accessible projects, with status filter and pagination |
get_project | read | Full detail for one project |
search_projects | read | Free-text search with filters and pagination |
create_project | write | Create a project with name, description and dates |
update_project | write | Update a project; omitted fields are left untouched |
#Tasks
| Tool | Scope | What it does |
|---|---|---|
list_tasks | read | List tasks, filtered by project, user or status |
list_tasks_v2 | read | Stricter contract, deterministic pagination and normalized ids |
get_task | read | Full detail for one task |
search_tasks | read | Free-text search with project, status, priority and assignee filters |
list_task_statuses | read | The workflow statuses configured for a project, in workflow order |
list_task_types | read | Task types available in the workspace (Bug, Task, Story, Epic, Feature…) |
create_task | write | Create a task with title, description, priority, assignment and dates |
update_task | write | Update a task by numeric id or uniq_id |
Tip
list_task_statuses matters more than it looks. Status names are configured
per project, so an assistant that guesses "Done" often guesses wrong, pointing
it at this tool first makes status changes reliable.
#Backlog hierarchy
Scrum backlog items, from Epic down. All four need mcp:epics.write.
| Tool | What it does |
|---|---|
create_epic | Create an Epic, the top-level backlog item, in a project |
create_feature | Create a Feature under an existing Epic |
create_story | Create a Story, optionally attached to a Feature |
create_subtask | Create a child work item under a Story or a Task |
Note
Reads for these live under the task tools, an Epic or Story is a work item,
so list_tasks, get_task and search_tasks return them. mcp:epics.read
appears in the scope vocabulary but nothing dispatches on it yet.
#Sprints
| Tool | Scope | What it does |
|---|---|---|
list_sprints | read | Sprints for a project, active first, filterable by status |
get_sprint | read | One sprint by numeric id or uniq_id |
create_sprint | write | Create a sprint; it starts not-yet-started |
update_sprint | write | Update a sprint's fields |
start_sprint | write | Start a sprint |
complete_sprint | write | Close a sprint; done tasks are snapshotted for velocity |
assign_task_to_sprint | write | Move a task into a sprint, or back to the backlog |
Note
Unless the company has parallel sprints enabled, only one sprint can be active
per project, start_sprint will refuse the second. Sprints are available on
v4 projects only.
#Timelogs
| Tool | Scope | What it does |
|---|---|---|
list_timelogs | read | Time entries for the authenticated user, filtered by project, task and date range |
create_timelog | write | Log time against a task, total_hours, or explicit start and end times |
update_timelog | write | Update an entry; omitted fields are left untouched |
#Users
Read-only, by design.
| Tool | What it does |
|---|---|
get_current_user | The authenticated user's profile, timezone, roles and default workspace |
list_users | Workspace directory, with free-text search and pagination |
get_user | One user by numeric id or uniq_id |
No user writes over MCP
There is no tool to invite, deactivate or re-role a member. Those stay in the admin UI deliberately, an assistant should not be able to alter who has access to your workspace.
#Test management
The largest surface: 21 tools over test cases, scenarios, steps and defects.
Deletes archive by default; pass hard_delete to remove permanently.
#Test cases
| Tool | Scope | What it does |
|---|---|---|
create_test_case | write | Create a test case, optionally attached to a scenario |
list_test_cases | read | Filter by project, scenario or status |
get_test_case | read | One test case by uniq_id |
update_test_case | write | Update supplied fields only |
delete_test_case | write | Archive, or hard_delete=true to remove |
#Test scenarios
| Tool | Scope | What it does |
|---|---|---|
create_test_scenario | write | Create a scenario in a project |
list_test_scenarios | read | Filter by project, type or status |
get_test_scenario | read | One scenario by uniq_id |
update_test_scenario | write | Update supplied fields only |
delete_test_scenario | write | Archive, or hard_delete=true to remove |
#Test steps
| Tool | Scope | What it does |
|---|---|---|
create_test_step | write | Append a step to a test case |
list_test_steps | read | Steps of a case, in position order |
update_test_step | write | Update a step within its case |
reorder_test_steps | write | Set step order by passing ids in the desired sequence |
delete_test_step | write | Unlink a step, or hard-delete it |
#Defects
| Tool | Scope | What it does |
|---|---|---|
create_defect | write | File a defect, optionally linked to a case, step or task |
list_defects | read | Filter by project, status, priority and severity |
get_defect | read | One defect by uniq_id |
update_defect | write | Update a defect's fields |
link_defect | write | Link a defect to a test case, step and/or task |
set_defect_status | write | Move a defect through its workflow |
Note
Test scenarios are available on v4 workspaces only.
#Checklists
20 tools over the checklist framework. There are two distinct layers, and picking the wrong one is the usual source of confusion:
- the company catalog, reusable groups and templates, shared workspace-wide;
- the per-work-item rail, the checklist actually attached to one task.
#Config and catalog reads
| Tool | What it does |
|---|---|
get_checklist_config | Whether the framework is on, the policy flags, and the required-groups matrix per work-item type |
list_checklist_groups | Catalog groups, system and custom |
list_checklist_templates | Templates with their items |
get_work_item_checklist | The checklist attached to one work item |
#Catalog management
All need mcp:checklists.write.
| Tool | What it does |
|---|---|
create_checklist_group | Create a custom catalog group; names are unique per company |
update_checklist_group | Update a catalog group, system groups cannot be renamed |
delete_checklist_group | Delete a custom group and its templates |
create_checklist_template | Create a template owning one group and a list of items |
update_checklist_template | Update a template and optionally replace its items |
delete_checklist_template | Delete a template and its items |
#Per work item
All need mcp:checklists.write. Each returns the refreshed checklist.
| Tool | What it does |
|---|---|
add_checklist_item | Add an item to a group on a work item |
update_checklist_item | Update an item |
delete_checklist_item | Remove an item |
complete_checklist_item | Mark complete or incomplete; omit the flag to toggle |
add_checklist_group | Attach an existing catalog group; duplicates are rejected |
add_checklist_group_from_template | Copy a template's group and items onto a work item |
create_custom_checklist_group | Create a one-off group on a work item, if the company allows it |
rename_checklist_group | Rename a group on this work item only, never the catalog |
delete_work_item_checklist_group | Remove a group and its items from this work item |
reorder_checklist_groups | Set the display order of a work item's groups |
Tip
Have the assistant call get_work_item_checklist before any write. The
per-item tools need the work-item group instance id, which is not the
catalog group id, that mismatch is the most common checklist error.
#Project context ("memory")
Standing notes the assistant recalls in later conversations, background, conventions, decisions.
| Tool | Scope | What it does |
|---|---|---|
get_project_context | mcp:context.read | Retrieve the saved context for the workspace |
add_project_context | mcp:context.write | Save a standing context entry |
#Document search
| Tool | Scope | What it does |
|---|---|---|
search_documents | mcp:documents.read | Semantic search over documents uploaded to the workspace, PDFs, Word, Excel, images |
#What these tools are good at
"What's overdue across everything I own?", tedious by hand, one call for an assistant.
Plan, start and close sprints, and move work in and out of them, without clicking through the board.
Turn a spec into scenarios, cases and ordered steps, then file defects against them.
Apply a template to a work item and tick items off as the conversation progresses.
Turn a chat thread or a code review into a backlog, epic to subtask.
"Log yesterday's work from my commits", reads git, writes timelogs.
#Limits worth knowing
- Scope failures happen at call time. The assistant sees the whole catalog
regardless of what you granted; a tool you did not approve returns
403naming the scope it wanted. - No bulk endpoints. Creating twenty tasks is twenty calls, each counting against the rate limit.
- No idempotency key. A retried create makes a second record. If a write appears to fail, have the assistant search before retrying.
- Some tools are v4-only. Sprints and test scenarios are not available on older workspaces.
- Not everything in the REST API is a tool. The domains above are the MCP surface; anything else is REST only.