All 342 MCP tools, grouped by domain, with the OAuth scope each one needs.
The server advertises 342 tools across 21 domains. Each one asserts a
scope before it runs, so what your assistant
can actually do is decided by the scopes your workspace grants, not by this list.
iAsk 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
Access is the scope family a tool asserts. Tools marked destructive delete or irreversibly change data; clients that honor MCP tool annotations can ask you before running them.
#Projects
Read, create, update and search the projects in a workspace.
| Tool | Access | What it does |
|---|
list_projects | read | List the projects the caller can see (owners and admins see every project; other members see projects they created or belong to; private projects are hidden unless shared with them), with optional filtering and pagination |
get_project | read | Get detailed information about a specific project. |
create_project | write | Create a new project with specified details including name, description, and dates. |
update_project | write | Update an existing project. |
search_projects | read | Search the projects the caller can see by free-text query and optional filters. |
#Tasks
List, read, create and update tasks, and look up the statuses and types a project accepts.
| Tool | Access | What it does |
|---|
list_tasks | read | List tasks with optional filtering by project ID, user ID, status, and pagination. |
get_task | read | Get detailed information about a specific task: its fields, its dependencies (predecessors), its dependents (successors), its linked tasks, and counts plus a preview of its comments and attachments. |
create_task | write | Create a new task in a project with specified details including title, description, priority, and assignment. |
update_task | write | Update an existing task. |
search_tasks | read | Search tasks by free-text query and optional filters (project, status, priority, assignee). |
list_task_statuses | read | List the workflow statuses configured for a project, in workflow order. |
list_task_types | read | List the task types available in the workspace (e.g. Bug, Task, Story, Epic, Feature) with their numeric ids. |
list_tasks_v2 | read | List tasks with strict project filtering, sprint/mine/status filters, deterministic pagination, and normalized identifiers. |
Read and post comments on a task. Posting does not send the notifications the web app would.
| Tool | Access | What it does |
|---|
list_task_comments | read | List the comments on a task, newest first, paginated. |
get_task_comment | read | Get a single comment on a task, with its body unclipped. |
add_task_comment | write | Post a comment on a task as the authenticated user. |
update_task_comment | write | Edit a comment on a task, replacing its body. |
#Dependencies, links and labels
Scheduling dependencies between tasks, plain links, and labels.
| Tool | Access | What it does |
|---|
list_task_dependencies | read | List a task's dependencies (the tasks it waits on) and its dependents (the tasks waiting on it), each with the dependency type: finish-to-start, start-to-start, finish-to-finish or start-to-finish. |
add_task_dependency | write | Make a task depend on another task (blocked-by): the task named in task_id waits on the task named in depends_on_task_id. |
update_task_dependency | write | Change the type of an existing dependency between two tasks: finish-to-start, start-to-start, finish-to-finish or start-to-finish (FS/SS/FF/SF also accepted). |
list_task_links | read | List the tasks linked to a task (relations such as related-to or duplicated-by), each with the link id needed to change it, plus the relation types this workspace has available. |
add_task_link | write | Link one task to another (a "related to" / "duplicated by" style relation, with no scheduling meaning — use add_task_dependency for that). |
list_task_labels | read | List the labels on a task and the active labels available to its project (project labels plus company-wide ones). |
add_task_labels | write | Add labels to a task. |
remove_task_label | write, destructive | Remove one label from a task, by label id or name. |
update_task_link | write | Change the relation of an existing link between two tasks — e.g. from related-to to duplicated-by. |
#Cross-project linking
Relations that span projects: the cross-project board, program flow, a task's relations across projects, and pickers for link targets.
| Tool | Access | What it does |
|---|
get_cross_project_board | read | Get the cross-project board: a read-only kanban of work items across every project you can access (or only the projects you name), grouped into New, In Progress, Resolved and Closed columns, newest first. |
get_program_flow | read | Get the program flow of a program (a project grouping other projects): its child projects you can access as swimlanes, and the dependency edges (prerequisite -> dependent, with FS/SS/FF/SF type) and link edges (with the relation, e.g. "Related to") between their work items, within and across projects, plus those work items. |
list_cross_project_relations | read | List every link and dependency of one work item in any project, in both directions: links it made and links made to it (worded from its side, e.g. "Duplicates" for the far end of "Duplicated by"), what it depends on and what depends on it. |
list_linkable_projects | read | List the projects you may link a work item into or pick a dependency from: active projects you can access, programs excluded, ordered by name. |
search_link_targets | read | Find work items to link to (kind=link) or to depend on (kind=dependency), in one project or across every project you can access (project_id="all", the default). |
#Attachments
Files attached anywhere in a task's comment thread.
| Tool | Access | What it does |
|---|
list_task_attachments | read | List the files attached to a task, newest first, paginated. |
#Backlog hierarchy
Epics, features, stories and subtasks. Orangescrum v4 projects only.
| Tool | Access | What it does |
|---|
get_epic | read | Get an Epic and the full hierarchy beneath it: its Features, the Stories under each Feature, and the tasks (and their subtasks) under each Story. |
create_epic | write | Create an Epic, the top-level Scrum backlog item, in a project. |
create_feature | write | Create a Feature under an existing Epic. |
create_story | write | Create a Story in a project. |
create_subtask | write | Create a child work-item under a Story or a Task. |
#Sprints
Create, start and complete sprints, and move work in and out of them.
| Tool | Access | What it does |
|---|
list_sprints | read | List sprints for a project. |
get_sprint | read | Get a single sprint by its numeric id or uniq_id. |
create_sprint | write | Create a new sprint (also called a milestone, iteration or release) with a name in a project. |
update_sprint | write | Update a sprint's title, description, or planned dates. |
start_sprint | write | Start a sprint. |
complete_sprint | write | Complete (close) a sprint. |
assign_task_to_sprint | write | Move a task into a sprint, or back to the backlog. |
#Timelogs
Log time against tasks and read it back.
| Tool | Access | What it does |
|---|
list_timelogs | read | List timelogs for the authenticated partner user, with optional filters by project, task, and date range. |
create_timelog | write | Log time against a task. |
update_timelog | write | Update a timelog entry. |
#Users
The connected user and the workspace directory.
| Tool | Access | What it does |
|---|
get_current_user | read | Return authenticated user profile including timezone, roles, and default workspace/company |
list_users | read | List users in the company with optional free-text search on name/email and pagination. |
get_user | read | Get detailed information about a specific user. |
#Project context ("memory")
Standing instructions the assistant reads at the start of a conversation.
| Tool | Access | What it does |
|---|
get_project_context | read | Retrieve the standing context ("memory") saved for this workspace — background, conventions, and instructions to keep in mind. |
add_project_context | write | Save a standing context ("memory") entry so it is recalled in future conversations. |
#Document search
Semantic search over documents uploaded to the workspace.
| Tool | Access | What it does |
|---|
search_documents | read | Search documents uploaded to this Orangescrum workspace (PDFs, Word, Excel, images) by meaning and return the most relevant excerpts with their source document. |
#Knowledge Base
The wiki: shelves, books, page trees and pages, with history, comments, action items, reviews, watching and links to work items.
#Library, books and search
| Tool | Access | What it does |
|---|
list_wiki_library | read | List the Knowledge Base (wiki) library: the shelves and the books you can see, each book with its page count, last activity, shelf and linked project. |
get_wiki_book | read | Get one Knowledge Base book: its details, shelf, linked project, owner, your capabilities in it (view, create, edit, comment, delete) and its top-level pages and folders with their child counts. |
get_wiki_book_tree | read | Get the full page tree of a Knowledge Base book: every live page and folder you can see, with parent_id and position so the hierarchy can be rebuilt, plus an indented outline. |
get_wiki_page | read | Read a Knowledge Base page: its body (HTML, or plain text with format=text), title, book, breadcrumb, labels, properties (frontmatter), publication state (draft, published, obsolete), review state, author and last editor, links to work items, projects and programs, your capabilities on it and whether you watch it. |
search_wiki_pages | read | Search the Knowledge Base pages you can see. |
list_wiki_backlinks | read | List the Knowledge Base pages whose body links to this page (backlinks), in any book you can see. |
list_wiki_page_attachments | read | List the files attached to a Knowledge Base page, newest first: name, size, type, source (uploaded or linked from the document repository), lock state, uploader, and the web address that serves the file to signed-in members. |
list_wiki_pages_for_target | read | List the Knowledge Base pages linked to a work item, a project or a program (the "Knowledge base" panel on those screens): find the specs, runbooks or meeting notes behind a piece of work. |
#Writing pages
| Tool | Access | What it does |
|---|
create_wiki_page | write | Create a Knowledge Base page (or a folder to group pages) in a book, at the top level or under a parent page. |
update_wiki_page | write | Change a Knowledge Base page: title, body, labels, properties (frontmatter), icon, description or publication state. |
move_wiki_page | write | Move a Knowledge Base page or folder, with everything under it: under another page (parent_id), to the top level of a book (book_id, which may be another book), or to another position among its siblings (position only). |
copy_wiki_page | write | Duplicate a Knowledge Base page next to itself as a draft titled "… (copy)", with its body, labels and properties but a fresh history. |
archive_wiki_page | write, destructive | Archive (delete) a Knowledge Base page or an empty folder. |
list_archived_wiki_pages | read | List archived (deleted) Knowledge Base pages, most recently archived first, so one can be brought back with restore_wiki_page. |
restore_wiki_page | write | Bring back an archived Knowledge Base page (see list_archived_wiki_pages). |
#History
| Tool | Access | What it does |
|---|
list_wiki_page_revisions | read | List the version history of a Knowledge Base page, newest first: revision number, title, note, author, when it was saved and whether it was a published version. |
get_wiki_page_revision | read | Read one saved version of a Knowledge Base page, with its body (HTML, or plain text with format=text), title, note and author. |
save_wiki_page_version | write | Save the current title and body of a Knowledge Base page as a named version in its history, without changing the page. |
restore_wiki_page_revision | write | Put an older version's body back on its Knowledge Base page. |
| Tool | Access | What it does |
|---|
list_wiki_page_comments | read | List the comments on a Knowledge Base page, oldest first, with author, body (HTML plus a plain-text copy), whether each is resolved, and emoji reactions. |
add_wiki_comment | write | Post a comment on a Knowledge Base page. |
resolve_wiki_comment | write | Mark a Knowledge Base page comment resolved, or open again with resolved=false. |
list_wiki_action_items | read | List Knowledge Base action items (to-dos captured on pages): on one page (scope=page with page_id), across a book (scope=book with book_id), assigned to you (scope=mine, the default) or every open one in the workspace (scope=open). |
save_wiki_action_item | write | Add an action item (a to-do) to a Knowledge Base page, or change one by passing action_item_id: text, assignee, due date or position; passing page_id with action_item_id moves it to that page. |
set_wiki_action_item_done | write | Mark a Knowledge Base action item done, or open again with done=false. |
delete_wiki_action_item | write, destructive | Delete an action item from a Knowledge Base page for good. |
get_wiki_review | read | Get a Knowledge Base page's review: its state (none, in_review, approved, changes_requested), reviewer, who asked, the latest note, whether you are the reviewer, and the last 30 review events. |
request_wiki_review | write | Send a Knowledge Base page to a reviewer: the page shows "in review" and the reviewer is notified. |
decide_wiki_review | write | Decide a Knowledge Base page review: approve (which publishes the page) or request_changes, with an optional note for the author, who is notified. |
watch_wiki_page | write | Watch a Knowledge Base page to be notified when it changes, or stop with watch=false. scope=subtree also covers every page under it, scope=space the whole book. frequency sets how notifications are emailed: immediate, daily or weekly digest, or off (in-app only). |
link_wiki_page | write | Link a Knowledge Base page to a work item, a project or a program, so it shows in that item's Knowledge base panel and in the page's links. |
unlink_wiki_page | write, destructive | Remove the link between a Knowledge Base page and a work item, project or program. |
#Books and shelves
| Tool | Access | What it does |
|---|
save_wiki_book | write | Create a Knowledge Base book (a wiki space), or change one by passing book_id: name, description, icon, cover colour, the project it belongs to, or its shelf (0 to unshelve). |
archive_wiki_book | write, destructive | Archive a Knowledge Base book. |
save_wiki_shelf | write | Create a Knowledge Base shelf to group books, or change one by passing shelf_id: name, description or icon. |
archive_wiki_shelf | write, destructive | Archive a Knowledge Base shelf. |
#Test Lab
Test cases, suites, plans, runs, scenarios, strategies, baselines and defects from Test Lab.
#Repository
| Tool | Access | What it does |
|---|
list_test_lookups | read | List the allowed values for Test Lab fields in this workspace: test case priority, type, state, template and automation status, and defect severity, priority, status, resolution and root cause. |
create_test_case | write | Create a test case in the Test Lab repository (/test-lab#/repository) of a project. |
list_test_cases | read | List Test Lab test cases (the /test-lab#/repository list), ordered by project and TC number. |
get_test_case | read | Get a Test Lab test case with all its fields and steps, plus its links (tasks, cases, defects, runs), comments, attachments and latest run results. |
update_test_case | write | Update a Test Lab test case. |
delete_test_case | write, destructive | Delete a Test Lab test case. |
list_test_case_versions | read | Version history of a Test Lab test case, newest first (up to 30). |
list_test_suites | read | List the Test Lab suites (the folder tree of the repository) of a project, with parent ids and case counts. |
create_test_suite | write | Create a test suite (a folder in the Test Lab repository, /test-lab#/repository) in a project, optionally inside a parent suite. |
update_test_suite | write | Rename a Test Lab suite, change its description, or move it under another suite of the same project. |
list_test_datasets | read | List the parameter datasets a project can use (its own plus workspace-wide). |
add_test_case_tags | write | Add tags to one or more Test Lab test cases (like the Add tag bulk action). |
export_test_cases | read | Export Test Lab test cases as CSV, the same format as the Test Lab Export button (TC id, title, priority, steps as "step => expected | ...", suite, owner, ...). |
create_test_dataset | write | Create a Test Lab parameter dataset: named columns and rows of values. |
update_test_dataset | write | Update a Test Lab dataset: rename, change description or project, or replace its columns and rows. |
list_test_shared_steps | read | List Test Lab shared steps: reusable step blocks a project's cases can copy in. |
update_test_shared_step | write | Edit a Test Lab shared step block: rename it or replace its steps. |
list_test_custom_fields | read | List the Test Lab custom field definitions (workspace-wide) for test cases and / or defects, with their keys, types and options. |
create_test_custom_field | write | Create a Test Lab custom field for test cases or defects (workspace-wide). |
update_test_custom_field | write | Edit a Test Lab custom field: label, type, options, required, visible or order. |
| Tool | Access | What it does |
|---|
list_test_comments | read | List comments on a Test Lab test case, defect or run (oldest first). |
add_test_comment | write | Add a comment to a Test Lab test case, defect or run (max 8000 chars). |
add_test_link | write | Link a Test Lab test case or defect to an Orangescrum task, another test case, a defect or a run. |
remove_test_link | write, destructive | Remove a Test Lab link by its link id (shown in get_test_case / get_defect links). |
list_test_attachments | read | List the files attached to a Test Lab test case, defect, scenario or run result, newest first, each with a link that opens it in Orangescrum (images inline, other files download; the viewer must be signed in). |
#Scenarios and strategies
| Tool | Access | What it does |
|---|
list_test_scenarios | read | List Test Lab scenario records (the /test-lab#/scenarios screen) with their child counts. |
get_test_scenario | read | Get a Test Lab test scenario with its cases. |
create_test_scenario | write | Create a Test Lab test scenario in a project; it gets the next number in the project. |
update_test_scenario | write | Update a Test Lab test scenario; only the fields you pass change. |
delete_test_scenario | write, destructive | Delete a Test Lab test scenario (soft delete). |
set_scenario_cases | write | Attach test cases to a Test Lab test scenario (attach=true, default) or detach them (attach=false). |
list_test_strategies | read | List Test Lab strategy records (the /test-lab#/strategies screen) with their child counts. |
get_test_strategy | read | Get a Test Lab test strategy with its scenarios. |
create_test_strategy | write | Create a Test Lab test strategy in a project; it gets the next number in the project. |
update_test_strategy | write | Update a Test Lab test strategy; only the fields you pass change. |
delete_test_strategy | write, destructive | Delete a Test Lab test strategy (soft delete). |
set_strategy_scenarios | write | Attach test scenarios to a Test Lab test strategy (attach=true, default) or detach them (attach=false). |
#Plans and runs
| Tool | Access | What it does |
|---|
get_test_run_setup | read | List what a project's Test Lab runs and plans can use: configurations, environments and open sprints / milestones. |
list_test_plans | read | List Test Lab test plans (the /test-lab#/plans screen) with their case selection, configurations and run count. |
get_test_plan | read | Get a Test Lab test plan with the runs it has launched and their progress. |
create_test_plan | write | Create a Test Lab test plan: which cases to run (selection), against which configurations, for which sprint. |
update_test_plan | write | Update a Test Lab test plan; only the fields you pass change. |
launch_test_plan | write | Launch a Test Lab test plan: creates one active run per configuration (or one run without), each with an item per selected case (per dataset row for parameterised cases). |
delete_test_plan | write, destructive | Delete a Test Lab test plan (soft delete). |
list_test_runs | read | List Test Lab runs (the /test-lab#/runs screen) with progress stats. source=exploratory lists exploratory sessions. |
get_test_run | read | Get a Test Lab run with every item (case, steps with dataset values filled in, status, assignee, comment), its stats and the defects raised in it. |
create_test_run | write | Start a Test Lab run in a project. |
update_test_run | write | Rename a Test Lab run or change its description, environment, sprint or assignee. |
record_test_result | write | Record a result in an active Test Lab run: one item (with optional per-step results) or the same result on several items of one run. |
list_test_result_history | read | Result history of one Test Lab run item, newest first, with step results and any defect raised. |
close_test_run | write | Close (complete) a Test Lab run or end an exploratory session. |
rerun_failed_tests | write | Start a new Test Lab run containing the failed and blocked items of an earlier run. |
delete_test_run | write, destructive | Delete a Test Lab run (soft delete). |
#Exploratory sessions
| Tool | Access | What it does |
|---|
start_exploratory_session | write | Start a Test Lab exploratory session (the /test-lab#/explore screen): a run with a charter and no scripted items. |
add_exploratory_note | write | Log a finding in an active Test Lab exploratory session: a note, bug, idea or question. |
list_exploratory_notes | read | List the findings (notes, bugs, ideas, questions) of a Test Lab exploratory session. |
#Baselines
| Tool | Access | What it does |
|---|
list_test_baselines | read | List Test Lab baselines (frozen snapshots of a project's test cases, the /test-lab#/baselines screen). |
create_test_baseline | write | Freeze the active test cases of a project (or of a suite and its sub-suites) as a Test Lab baseline, to compare against or restore from later. |
compare_test_baseline | read | Compare a Test Lab baseline with the current test cases (default) or another baseline of the same project: which cases changed (and which fields), were added, removed or moved. |
restore_test_baseline | write | Restore test cases to their content in a Test Lab baseline. |
delete_test_baseline | write, destructive | Delete a Test Lab baseline and its frozen cases (permanent, as in Test Lab). |
#Defects
| Tool | Access | What it does |
|---|
list_defects | read | List Test Lab defects (the /test-lab#/defects list), newest BUG number first. |
get_defect | read | Get a Test Lab defect with all its fields, related defects, watchers, change history, links (tasks, cases, runs), comments and attachments. |
create_defect | write | Report a defect in Test Lab (/test-lab#/defects) for a project. |
update_defect | write | Update a Test Lab defect. |
set_defect_status | write | Move a Test Lab defect to another workflow status (default new, open, in_progress, fixed, retest, verified, closed, rejected, duplicate). |
delete_defect | write, destructive | Delete a Test Lab defect (soft delete, as in the Test Lab UI). |
add_defect_relation | write | Relate two Test Lab defects: duplicate_of, relates, blocks or blocked_by. |
remove_defect_relation | write, destructive | Remove a relation between two Test Lab defects by its relation id (from get_defect relations). |
#Versions and releases
Versions, releases, their items and progress, readiness, approval chains, release notes and the release governance around them.
#Versions, releases and approvals
| Tool | Access | What it does |
|---|
list_versions | read | List versions (planned product versions such as 4.2) in one project, or across every project you can access when project_id is omitted. |
get_version | read | Get one version with its owner, dates, status, the statuses it can move to next, item and release counts, and its recent change history. |
create_version | write | Create a version in a project. |
update_version | write | Update a version's name, description, goal, owner or planned dates. |
transition_version | write | Move a version to another status: Draft, Planned, Active, On Hold, Released or Archived. |
delete_version | write, destructive | Delete a version (soft delete, as the Delete button in the app; the plugin calls this archiving). |
list_version_items | read | List the work items (epics, features, stories, tasks, defects) linked to a version, newest first, with title, number, status, due date and assignee. |
add_version_items | write | Link work items to a version in one all-or-nothing call (up to 100). |
remove_version_item | write, destructive | Unlink one work item from a version. item_id is the link id shown by list_version_items, not the task id. |
get_version_progress | read | Completion of a version: linked items done out of total, overall percent, and per type. |
get_release_roadmap | read | Roadmap of a project, or of every project you can access when project_id is omitted: versions in planned start order, each with its releases. |
list_releases | read | List releases (shippable builds of a version, such as 4.2.1) for a version, a project, or every project you can access. |
get_release | read | Get one release with its version, type, dates, owner, status, approval chain status, the statuses you can move it to next (shipping and rolling back appear only with those permissions), whether its item scope is frozen (scope_locked, from Ready onwards), item count and recent change history. |
create_release | write | Create a release under a version; it starts in Draft. release_number must be unique in the version (letters, digits, dot, dash, underscore, space; max 50). type is one of Major, Minor, Patch, Hotfix, Beta or Release Candidate. |
update_release | write | Update a release's name, description, type, planned date or owner. |
transition_release | write | Move a release to another status: Draft, Planned, Testing, Ready, Approved, Released, Rolled Back or Cancelled. |
delete_release | write, destructive | Delete a release (soft delete, as in the app). |
list_release_items | read | List the work items included in a release, newest first, with title, status and assignee. |
add_release_items | write | Include version items in a release, all or nothing (up to 100). |
remove_release_item | write, destructive | Remove one item from a release. item_id is the link id from list_release_items. |
get_release_readiness | read | Whether a release is ready to move to Ready: percent of its items done (Resolved or Closed) against the threshold for its type (Major and Minor 100, others 90), open stories, tasks and defects, open critical or blocker defects (any one makes it not ready), items blocked by an unfinished predecessor, unresolved dependencies, and required checklist items still unchecked (blocking_required_items). ready is false when it has no items. |
list_my_pending_approvals | read | List release approval steps waiting for you, with the release, the level, and can_act (true when every lower level is already approved, and false on your own releases when the company enables separation of duties). |
get_release_approval_chain | read | The approval chain of a release: each level's approver, status, comment and time, the chain status (in_approval, approved, rejected, cancelled), and whether you can act now. |
approve_release_step | write | Approve a release approval step assigned to you. |
reject_release_step | write | Reject a release approval step assigned to you, with a required comment explaining why. |
cancel_release_approval_chain | write, destructive | Cancel the whole approval chain of a release (every live step). |
get_release_notes | read | Get a release's notes (markdown), whether they were generated or written by hand (is_manual_override), and when. |
generate_release_notes | write | Generate a release's notes from its items: New Features (epics, features), Improvements (stories, tasks) and Fixed Issues (defects). |
update_release_notes | write | Replace a release's notes with your own markdown. |
#Release dependencies
| Tool | Access | What it does |
|---|
list_release_dependencies | read | What a release waits on (blocked_by) and what waits on it (blocks). |
add_release_dependency | write | Make a release wait on an upstream release. hard (default) blocks moving the release to Released while the upstream is not shipped or cancelled; soft is informational. |
remove_release_dependency | write, destructive | Delete a dependency, addressed through either of its releases (the waiting one or the upstream). |
#Go-live checklist
| Tool | Access | What it does |
|---|
list_release_checklist | read | A release's go-live checklist in order: each item's text, whether it is required, and whether, by whom and when it was checked. |
add_release_checklist_item | write | Append an item to a release's go-live checklist. |
set_release_checklist_item | write | Check or uncheck an item of a release's checklist. |
delete_release_checklist_item | write, destructive | Delete an item from a release's checklist. |
#Blackout windows
| Tool | Access | What it does |
|---|
list_blackout_windows | read | List the company's release blackout windows (periods when releases should not ship, such as a code freeze), latest first: start and end, hard or soft enforcement, one-off or yearly recurrence, and the release types and project ids it applies to (empty means all). |
create_blackout_window | write | Create a company-wide release blackout window. starts_at and ends_at take YYYY-MM-DD or YYYY-MM-DD HH:MM (end after start). enforcement is hard or soft; recurrence none (default) or annually, which repeats the same dates every year. |
deactivate_blackout_window | write, destructive | Deactivate a blackout window so it no longer applies. |
check_release_blackout | read | Check whether a release would ship inside an active blackout window: windows that apply to its project and type and cover the date, split into hard and soft, skipping windows already overridden for it. |
override_release_blackout | write | Record an override that lets a release ship inside a blackout window, with the reason (requires the VRM administration permission). |
#Customer impact
| Tool | Access | What it does |
|---|
list_impact_segments | read | List the company's customer impact segments (e.g. enterprise, smb) by label. |
create_impact_segment | write | Create a customer impact segment. key is lower-cased and may hold only letters, digits and underscores (max 100), unique in the company even among deactivated segments; label is the display name. |
deactivate_impact_segment | write, destructive | Deactivate a customer impact segment. |
assign_impact_segments | write | Mark a version item as affecting customer segments. |
unassign_impact_segment | write, destructive | Remove one customer segment from a version item. |
get_customer_impact_report | read | Releases shipped between from and to (YYYY-MM-DD, default the current year) that included version items assigned to a customer segment, latest first: release number, name, type, ship date, how many such items it shipped (segment_count) and its release notes. |
#Release templates
| Tool | Access | What it does |
|---|
list_release_templates | read | List the company's release templates by name: release type, default release fields and go-live checklist. |
get_release_template | read | One release template with its type, default release fields (default_fields) and checklist items. |
create_release_template | write | Create a release template: a unique name, an optional release type (Major, Minor, Patch, Hotfix, Beta, Release Candidate), default release fields (name, release_number, description, planned_release_dt, owner_id) and go-live checklist items in order, each required unless is_required is false. |
create_release_from_template | write | Create a Draft release under a version from a template. |
#Analytics, calendar and dashboard
| Tool | Access | What it does |
|---|
get_release_analytics | read | Release analytics over the projects you can access: approval cycle time (median and 90th percentile hours per approval level and approver), predictability (mean days late or early per release type and quarter), defect leakage (defects linked to each shipped release) and release velocity (releases shipped per quarter and type). release_type narrows cycle time and predictability; project_id narrows release velocity only, as in Orangescrum. |
get_release_time_in_status | read | How many hours a release spent in each status, from its status history in order; the last segment is its current status, counted until now. |
get_release_failure_trend | read | Per month over a period (3m, 6m, 12m default, 24m): how many releases were rolled back, cancelled, or shipped later than planned (slipped), for one project or every project you can access. |
get_version_burndown | read | A version's burndown over its planned start to end dates (ideal versus remaining items per day; empty with reason no_planned_window when the dates are not set) and its weekly velocity. |
get_release_calendar | read | Releases planned or shipped between from and to (YYYY-MM-DD, default the current month), by planned date, at most 500, for one project or every project you can access, optionally one type or status. |
get_release_dashboard | read | The release dashboard: up to 20 upcoming unshipped releases by planned date, each with its readiness (percent done, open items, critical defects, dependencies, ready flag), and up to 100 releases shipped in the last 90 days. |
list_version_release_activity | read | The audit trail of a release or a version, newest first: each field change, status move, item link, approval, checklist or note event with old and new values, who did it and when. get_release and get_version show only the last 10; this pages through all of it. |
#Workflow rules and lookups
| Tool | Access | What it does |
|---|
get_version_release_workflow | read | The status workflow in force for versions or releases, company-wide or for a project: every status, the moves allowed from each, which moves need the approval chain, the conditions attached to a move (e.g. readiness at least 90%), terminal statuses, and where the rules come from (project, company or built-in defaults). |
get_work_item_versions | read | Which versions a work item is linked to, among projects you can access, latest planned end first, with the link id (version_item_id) for remove_version_item or assign_impact_segments. entity_type is Epic, Feature, Story, Task or Defect; entity_id is the numeric task or defect id. |
#Scaled Agile (SAFe)
Release trains, program increments, the program board, PI objectives, ROAM risks, WSJF, Inspect & Adapt and flow metrics.
#Agile Release Trains
| Tool | Access | What it does |
|---|
list_arts | read | List the workspace's Agile Release Trains (ARTs), newest first, with each train's cadence (PI and iteration length in weeks, whether it has an IP iteration), status, active team count and program increments. |
get_art | read | Get one Agile Release Train: its cadence and status, the teams on it (team_id and name), the teams that could still be attached (attachable_teams), the SAFe role holders (RTE, product manager, system architect, business owners, each with an assignment id), linked projects and its program increments. |
get_art_health | read | Health of an Agile Release Train at a glance: its current program increment and how far through it is (the Executing PI, else the one whose dates include today, else the newest), PI counts by status, the current PI's objectives and business value delivered (actual over planned), open ROAM risks, completion of work items planned onto the ART, dependency count and the Release Train Engineer. |
list_art_dependencies | read | List the backlog dependencies (blocks, related, duplicates, parent_of) that touch any work item planned onto an Agile Release Train, newest first — including dependencies on items in other trains, which is where cross-ART risk shows. |
create_art | write | Create an Agile Release Train. code is upper-cased and must be unique in the workspace. |
update_art | write | Update an Agile Release Train's name, code, description, program or cadence. |
archive_art | write | Archive an Agile Release Train (action archive) or bring an archived one back (action restore). |
attach_art_team | write | Attach a team to an Agile Release Train from today. get_art lists the teams that can be attached (attachable_teams). |
detach_art_team | write, destructive | Detach a team from an Agile Release Train as of today. |
attach_art_project | write | Link a project to an Agile Release Train, so its epics, features and stories appear in the train's backlog. |
detach_art_project | write, destructive | Unlink a project from an Agile Release Train. |
assign_art_role | write | Give a workspace member a SAFe role on an Agile Release Train: rte (Release Train Engineer), product_manager, system_architect or business_owner. |
revoke_art_role | write, destructive | Revoke a SAFe role assignment on an Agile Release Train as of today. |
#Program increments and the program board
| Tool | Access | What it does |
|---|
list_program_increments | read | List program increments (PIs), latest start first, with their iterations. |
get_program_increment | read | Get one program increment: its ART, theme, business context, dates, status (planning, executing, closed), iterations, PI objectives and ROAM risks. |
create_program_increment | write | Create a program increment (PI) on an ART, in Planning. |
update_program_increment | write | Update a program increment's name, theme, business context or dates. |
transition_program_increment | write | Move a program increment along its lifecycle: lock (Planning to Executing, which freezes its plan) or close (Executing to Closed). |
get_iteration | read | Get one iteration of a program increment: its dates, whether it is the IP iteration, the backlog items planned into it (planned_items) and the items placed in its program board cells (board_items). |
get_program_board | read | Get the program board of a program increment: its iterations (columns), the ART's teams (rows), the work items placed in each team-and-iteration cell with their committed load, and the dependencies touching those items, including ones reaching outside the PI. |
place_on_program_board | write | Place a work item (usually a feature) in a team-and-iteration cell of a program increment's board, with how much of the team's capacity it commits (1 to 100 percent, default 100). |
remove_from_program_board | write, destructive | Remove a placement from a program increment's board. |
#PI objectives, risks and confidence votes
| Tool | Access | What it does |
|---|
list_pi_objectives | read | List a program increment's team PI objectives, committed first, with planned business value (1 to 10) and, once recorded, actual business value. |
create_pi_objective | write | Add a PI objective: what a team (or the whole ART when team_id is omitted) intends to achieve, committed or as a stretch (uncommitted) objective, with planned business value 1 to 10 (default 5). |
update_pi_objective | write | Update a PI objective's description, team, committed flag or planned business value, or record the actual business value delivered (0 to 10), which business owners score at the end of the PI and which drives PI predictability. |
list_roam_risks | read | List a program increment's ROAM risks, newest first, each Resolved, Owned, Accepted or Mitigated, with its owner. |
create_roam_risk | write | Raise a risk on a program increment and ROAM it: resolved, owned (default), accepted or mitigated, optionally with an owner. |
update_roam_risk | write | Update a ROAM risk's description, owner or status (resolved, owned, accepted, mitigated). |
cast_confidence_vote | write | Cast your fist-of-five confidence vote (1 to 5) on a program increment's plan, for a voting round (default 1). |
get_confidence_vote_summary | read | Confidence vote results for a program increment, per round: number of votes and average overall and per team. |
#Backlog, dependencies and WSJF
| Tool | Access | What it does |
|---|
list_safe_backlog | read | List the SAFe backlog: epics, features and stories with their ART, PI, iteration, team, kanban state, rank and latest WSJF score. |
get_safe_backlog_item | read | Get one epic, feature or story with its SAFe planning (ART, PI, iteration and team, with names), kanban state and the states it can move to next, rank, sizing, latest WSJF score and recent WSJF history, and its backlog dependencies. |
update_safe_backlog_planning | write | Set an epic, feature or story's SAFe planning: ART, program increment, iteration, team, rank, story subtype (user or enabler), enabler kind (architectural, infrastructure, exploration, compliance), feature estimate and epic size. |
transition_safe_backlog_item | write | Move an epic, feature or story to another kanban state of its level (see list_safe_kanban_states, or next_states on get_safe_backlog_item). |
list_safe_kanban_states | read | List the portfolio kanban states for epics, features and stories (or one level): order, whether each is an initial or terminal state, WIP limit, and the states each one may move to next — each transition rule with the extra permission it demands, if any, and whether it is a global default. |
add_backlog_dependency | write | Record a dependency between two backlog items: the first blocks (default), is related to, duplicates or is the parent of the second. |
remove_backlog_dependency | write, destructive | Remove a backlog dependency by its id (from get_safe_backlog_item or list_art_dependencies). |
record_wsjf_score | write | Score an epic, feature or story for Weighted Shortest Job First. |
get_wsjf_leaderboard | read | Rank an ART's epics, features or stories (default features) by their latest WSJF score, highest first, unscored last — the order to pull work in. |
#Inspect & Adapt and flow metrics
| Tool | Access | What it does |
|---|
list_inspect_adapt_sessions | read | List Inspect & Adapt sessions, most recent first, with their PI, facilitator, improvement item count and the predictability the web app last cached. |
get_inspect_adapt_session | read | Get one Inspect & Adapt session: its PI, system demo notes, facilitator, improvement items from the problem-solving workshop, and PI predictability computed now — per team and for the ART, actual over planned business value of committed objectives. |
create_inspect_adapt_session | write | Open the Inspect & Adapt session for a program increment, with the date it is held, optional system demo notes and a facilitator. |
add_improvement_item | write | Add an improvement item from the problem-solving workshop to an Inspect & Adapt session: the problem, its root cause and countermeasure, an owner, and the PI the fix is targeted at. |
update_improvement_item | write | Update an improvement item's problem, root cause, countermeasure, owner, target PI or status (open, in_progress, done, dropped). |
get_flow_metrics | read | Get an Agile Release Train's flow metrics: flow velocity, distribution, time, load and efficiency as stored period series, or one metric. |
recompute_flow_velocity | write | Recompute an Agile Release Train's weekly flow velocity: for each Monday-to-Sunday week, how many of its backlog items moved into a terminal kanban state. |
#Dashboard, pickers and permissions
| Tool | Access | What it does |
|---|
get_safe_dashboard | read | The Scaled Agile portfolio at a glance, optionally for one ART or one Program: the current program increment (days left, features done, average confidence vote, ROAM counts), flow (items finished in 7 days, cycle time, WIP), items per kanban state per level, each active ART's Executing PI progress and blocking dependencies, objective status (achieved / on track / at risk / behind), dependencies by type, per-team progress with a 4-week throughput series, features by project and the top risks. |
list_safe_programs | read | List the workspace's active Programs — the portfolio grouping an Agile Release Train belongs to (projects whose purpose is "program") — with how many live projects each holds. |
list_safe_teams | read | List the workspace's active teams (status active and not past their end date) with member counts. |
get_safe_permissions | read | Show what you are allowed to do in Scaled Agile: every SAFe permission (e.g. pi_lock, objective_record_bv, backlog_transition) with whether your role passes it, grouped as the web app's permission matrix groups them. |
#Resource management
Availability and capacity, utilization of logged time, the allocation report and skills.
| Tool | Access | What it does |
|---|
get_resource_availability | read | Resource availability over a date range (the Resource Availability page): for each resource, capacity hours (the company's work hours on working days; weekends, company holidays, 2nd/4th Saturdays when enabled and the person's leave days have none), hours booked on tasks, overload hours, free hours, utilization %, the dates they are overloaded and on leave, their skills, and a status (available / busy / over_utilized). |
get_resource_day_bookings | read | What one person is booked on for a single day (the cell popup of the Resource Availability page): each task with booked and overload hours, the day's work hours, hours logged, used hours (the larger of booked and logged), available hours, and whether the day is a weekend, holiday or a leave day (with the reason). |
get_resource_summary | read | Summary of one person's availability over a date range (the resource summary popup of the Resource Availability page): total, working, weekend, holiday and leave days; capacity, booked, overload, used and remaining hours; utilization %; overloaded dates; the tasks they are booked on (most hours first); their leaves and the holidays in the range. |
get_resource_utilization | read | Resource utilization from logged time (the Utilization page's Log View): hours spent grouped by any of date, resource, project, task_title, task_group, task_type, label and is_billable (default: all but task_type), with totals over everything that matches (spent, billable, non-billable, estimate of the distinct tasks, resource and task counts). |
get_team_utilization | read | Team utilization (the Utilization page's Capacity View): for each resource, hours logged against capacity per ISO week of a month (period=month) or per month of a calendar quarter (period=quarter), with a utilization % and band per bucket (red up to 40% or exactly 80%, amber between 40% and 80%, green above 80%), plus per-bucket team totals. |
get_allocation_report | read | The Resource Allocation Report: per task, hours per day over a date range, with daily totals and the grand total. view=estimated (default) shows planned effort: the hours booked plus overloaded for each task per day when Resource Availability is on (mode bookings), otherwise each task's estimate spread evenly from its start to its due date (mode estimate_spread); it covers active tasks starting or due in the range. view=spent shows hours logged per task per day, split billable / non-billable. |
get_allocation_weekly_status | read | The weekly status tab of the Resource Allocation Report: open tasks (new or in progress) created in the date range, bucketed by due date into overdue (due before now), current (due by the end of the range, or no due date) and future (due after the range), with counts and the number of projects involved. |
list_resource_skills | read | List the workspace's skills, alphabetically, each with the people holding it and their years of experience. |
#Attendance
Clock status, clock in and out, attendance records, who is in today, the dashboard and reports.
| Tool | Access | What it does |
|---|
get_attendance_status | read | Your attendance right now: whether you are clocked in (and since when, where, on which project), today's clock sessions with total hours and the day status (Present / Present (Late)), the work locations clock_in accepts (work_location_id), and whether the company's clock restrictions (IP allowlist, geo-fence) allow clocking through MCP at all (clock_restrictions.can_clock_via_mcp, with the reason when not). |
clock_in | write | Clock yourself in now (your own attendance only). |
clock_out | write | Clock yourself out of your open session (even one started on an earlier day), with an optional note that replaces the session's note. |
list_attendance_records | read | Timesheet of clock sessions for a period (default the last 30 days, at most 92 days): per-day totals with first clock-in, last clock-out and the day status (Present, Present (Half Day / Partial / Late / Overtime), credit), plus the individual sessions (paged, newest first). |
get_team_attendance | read | Who is in, out or on leave on a day (default today): for each employee you can see (your direct reports, or the whole company with view-all attendance access) their presence (clocked_in, clocked_out, not_clocked_in), first clock-in, last clock-out, hours, any approved leave covering the day, and the team grid's day status (Weekend, Holiday, Leave, Present..., Absent), with counts. |
get_attendance_dashboard | read | Your Attendance & Leave dashboard: today's clock summary, this year's leave request counts (pending, approved, rejected), the next five holidays, and for managers and admins who is on leave today with present / on leave / absent counts over their team or company, plus the number of active users. |
get_attendance_report | read | An attendance report for a period (default this month to date): attendance_summary (days present, total and average hours per person) or late_arrivals (each late clock-in). |
#Leave
Leave types, balances, holidays, requests, approvals and reports.
| Tool | Access | What it does |
|---|
list_leave_types | read | The active leave types you can apply for (id, name, code, paid, whether half days are allowed). |
get_leave_balances | read | Leave balances per leave type for a year (default this year): annual quota, carried forward, accrued, used, pending and available days. |
list_holidays | read | The company's holiday calendar for a year (default this year): company and global holidays with date, weekday, type and whether it is a half day. |
list_leave_requests | read | Leave requests, newest first. scope: my (your own), team (your direct reports; everyone with view-all leave access) or all (the whole company with view-all leave access, otherwise your own). |
get_leave_request | read | One leave request with its approval chain: each level's approver (or role), status, comment and when they acted, and whether it is waiting on you (can_act). |
preview_leave_days | read | How many leave days a request over the dates would count, exactly as apply_leave will: weekends, holidays and (where observed) 2nd/4th Saturdays are excluded; a half day counts 0.5. |
apply_leave | write | Apply for leave for yourself: leave_type_id (from list_leave_types), start_date, end_date and a reason; for a half day set is_half_day with the same start and end date and optionally half_day_period (first_half or second_half). |
cancel_leave_request | write, destructive | Cancel a leave request that is still pending or in approval; its days return to the available balance and its pending approvals are withdrawn. |
get_leave_report | read | A leave report: leave_summary (requests and days per person by status and leave type, for requests inside the period, default this month to date) or leave_balance (this year's balances per person and type). |
list_leave_approvals | read | Leave requests waiting on your approval, one row per approval step assigned to you, with the request, the full approval chain and can_act (true once every lower level has approved). |
approve_leave_request | write | Approve a leave request at your level of its approval chain, with a required comment. |
reject_leave_request | write, destructive | Reject a leave request at your level of its approval chain, with a required comment. |
#Risk management
The risk register with comments, links, watchers and approvals, plus the dashboard, heat map, reports and ISMS catalogues.
#Register
| Tool | Access | What it does |
|---|
list_risks | read | List and search the Risk Management register (not SAFe ROAM risks): each risk's display id (RISK-0042), title, score and rating, status, owner and project. |
get_risk | read | Read one risk in full: assessment (inherent and residual score and rating), mitigation, dates, ISMS fields, and where it stands in its workflow — every status it can move to next, whether you may take that step, whether it needs a comment and which required fields are still empty. |
get_risk_settings | read | Everything needed to fill a risk in correctly. |
create_risk | write | Create a Risk Management risk (for SAFe program risks use create_roam_risk). |
update_risk | write | Update a risk's fields; only the fields you pass change, and the score and rating are recomputed. |
transition_risk | write | Move a risk to another status of its workflow (get_risk lists the allowed next statuses). |
delete_risk | write, destructive | Delete a risk from the register. |
| Tool | Access | What it does |
|---|
list_risk_comments | read | List the comments on a risk, oldest first, with author and time. |
add_risk_comment | write | Post a comment on a risk. |
update_risk_comment | write | Edit a comment on a risk. |
delete_risk_comment | write, destructive | Delete a comment on a risk. |
#Links
| Tool | Access | What it does |
|---|
list_risk_links | read | List the work items (tasks) linked to a risk with their link type, and the related risks with their relationship (parent, dependent, duplicate, derived). |
list_task_risks | read | List the Risk Management risks linked to a work item (task), with the link type, score, rating and status — the task risk panel of the web app. |
link_risk_task | write | Link a work item (task) to a risk, e.g. a task the risk blocks or that mitigates it. |
unlink_risk_task | write, destructive | Remove the link between a work item (task) and a risk; list_risk_links shows the current links. |
link_risks | write | Relate a risk to another risk of the workspace: parent, dependent (default), duplicate or derived. |
unlink_risks | write, destructive | Remove the relationship (parent, dependent, duplicate or derived) from a risk to another risk; both risks stay as they are. |
#Watchers and approvals
| Tool | Access | What it does |
|---|
add_risk_watcher | write | Add a member as a watcher of a risk; they are notified of status changes and comments. |
remove_risk_watcher | write, destructive | Stop a member watching a risk, so they no longer get its status-change and comment notifications. |
list_risk_approvals | read | List risk approval steps. |
approve_risk_step | write | Approve one approval step of a risk, addressed by its step_index from list_risk_approvals. |
reject_risk_step | write | Reject one approval step of a risk, addressed by its step_index from list_risk_approvals, with the reason. |
#Dashboard, heat map and reports
| Tool | Access | What it does |
|---|
get_risk_dashboard | read | The Risk Management dashboard: total and open risks, closure rate, escalated share and average resolution time; counts by rating, status and category; mitigation progress; overdue reviews; recently added risks; and open risks blocking work items. |
get_risk_heatmap | read | The probability × impact heat map (risk matrix) of open risks: one cell per rating pair on the methodology scale, with its risks and the rating band the cell falls in. |
get_risk_report | read | Run a Risk Management report: register (every risk with score, rating, owner, status), summary (counts and shares by rating, category, status), overdue (past review date), trend (opened and closed per month, last six months), escalated, dependencies (risks with links), treatment (treatment plan, planned vs actual closure, lateness), residual (inherent vs residual score, reduction, within acceptance) or soa_coverage (risks per ISO 27001 Annex A control). |
list_risk_catalogue | read | List an ISMS catalogue: threats or vulnerabilities (with their default rating and how many risks use them — pass the id as threat_id / vulnerability_id), or the ISO/IEC 27001:2022 Annex A controls (for soa_controls), with how many risks map to each. |
list_risk_activity | read | A risk's audit trail, newest first: creation, every field change with old and new value, status moves, comments, links, watchers and approvals, with who and when. |
#Checklists
Company checklist settings, the group and template catalog, and checklists on individual work items.
#Config and catalog reads
| Tool | Access | What it does |
|---|
get_checklist_config | read | Read the company checklist framework configuration: whether it is enabled, the bypass and custom-group policy flags, and the required-groups matrix per work-item type. |
list_checklist_groups | read | List the company catalogue checklist groups (system and custom). |
list_checklist_templates | read | List the company checklist templates with their items. |
get_work_item_checklist | read | Read a work item's checklist: its groups with nested items and the overall/per-group completion status. |
#Catalog management
| Tool | Access | What it does |
|---|
create_checklist_group | write | Create a custom company-catalogue checklist group. |
update_checklist_group | write | Update a catalogue checklist group. |
delete_checklist_group | write | Delete a custom catalogue checklist group (and its templates). |
create_checklist_template | write | Create a checklist template that owns one catalogue group and a list of item labels. |
update_checklist_template | write | Update a checklist template. |
delete_checklist_template | write | Delete a checklist template and its items. |
#Per work item
| Tool | Access | What it does |
|---|
add_checklist_item | write | Add a checklist item to a group on a work item. |
update_checklist_item | write | Update a checklist item's label (text only). |
delete_checklist_item | write | Delete a checklist item from a work item. |
complete_checklist_item | write | Mark a checklist item complete or incomplete. |
add_checklist_group | write | Attach an existing catalogue checklist group (by its catalogue group id) to a work item. |
create_custom_checklist_group | write | Create a one-off custom checklist group directly on a work item (not from the catalogue). |
rename_checklist_group | write | Rename a checklist group on a work item (this work item only — never the shared catalogue). |
delete_work_item_checklist_group | write | Remove a checklist group (and its items) from a work item. |
reorder_checklist_groups | write | Set the display order of a work item's checklist groups. |
add_checklist_group_from_template | write | Copy a checklist template (its group and all items) onto a work item as an independent group. |
🔍Cross-project questions"What's overdue across everything I own?", tedious by hand, one call for an
assistant.
🏃Sprint mechanicsPlan, start and close sprints, and move work in and out of them, without
clicking through the board.
🧪QA authoringTurn a spec into scenarios, cases and ordered steps, then file defects
against them.
✅Checklist hygieneApply a template to a work item and tick items off as the conversation
progresses.
📝Capture from contextTurn a chat thread or a code review into a backlog, epic to subtask.
⏱Time reconstruction"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 your workspace allows; a tool outside those scopes returns
a
permission_denied error naming 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, test scenarios, the Knowledge Base,
attendance, leave and risk management 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.
