Orangescrum
Documentation index for AI agents (llms.txt). A markdown version of this page is available at /mcp.md or by requesting this URL with the header Accept: text/markdown.

MCP server

Connect Claude, or any Model Context Protocol client, straight to your Orangescrum workspace. The assistant gets 342 tools and can answer questions about your real projects and create work for you, signed in as you and limited to the workspace you choose. There is no integration to build. It is listed in the official MCP Registry as com.orangescrum/orangescrum-mcp-server.

What this is

The Model Context Protocol is an open standard for connecting AI assistants to the systems where work actually lives. Instead of pasting project updates into a chat window, you point the assistant at Orangescrum once and it can read and act for itself.

Concretely, that means the assistant can:

  • Answer questions from live data: what is overdue, who is loaded, what shipped last sprint.
  • Create and update projects, tasks, subtasks, epics, features, and stories.
  • Run sprints: create one, start it, assign work to it, close it.
  • Log time, and read time logs back for reporting.
  • Comment on tasks, and manage their dependencies, links, and labels.
  • Drive Test Lab: test cases, suites, plans, runs, scenarios, baselines, and defects.
  • Manage versions and releases, including readiness, approvals, and release notes.
  • Run Scaled Agile: release trains, program increments, the program board, PI objectives, and WSJF.
  • Manage checklists on any work item.

Connect a client

The server speaks HTTP and authenticates with OAuth. Your client opens a browser window, you sign in to Orangescrum, and the connection is bound to your account. No API key to paste, no secret in a config file. The server URL is https://mcp.orangescrum.com/mcp/partner.

// claude_desktop_config.json
// macOS  ~/Library/Application Support/Claude/claude_desktop_config.json
// Windows  %APPDATA%\Claude\claude_desktop_config.json

{
  "mcpServers": {
    "orangescrum": {
      "command": "npx",
      "args": [
        "-y",
        "mcp-remote",
        "https://mcp.orangescrum.com/mcp/partner"
      ]
    }
  }
}
Restart the client after editing a config file.

Once connected, ask the client to list its tools. You should see the Orangescrum tools listed below. If nothing appears, the sign in probably did not complete: disconnect and add the server again.

Try it

Nothing special is needed to invoke a tool. Ask in plain language and the assistant picks the right one.

What is overdue across all my projects, and who owns each one?

Which tasks did I close yesterday? Draft my standup.

Show me the open defects on the Website Redesign project, worst first.

Authentication

The primary endpoint is /mcp/partner, protected by OAuth bearer tokens. Clients discover how to authenticate automatically from these documents, so in most cases you only ever paste the server URL:

  • /.well-known/oauth-authorization-server
  • /.well-known/oauth-protected-resource
  • /oauth/register

Dynamic client registration is supported, which is why clients you have never configured before can connect with only a URL.

Requests are rate limited to 120 per minute and 5,000 per day, counted per IP address. Going over returns a JSON-RPC error; back off and retry.

A legacy API key endpoint exists at /mcp/partner-legacy for integrations built before OAuth. It is disabled by default and kept only for migration. Use the OAuth endpoint for anything new.

Tool reference

342 tools in 49 groups. You do not call these yourself, the assistant does, but knowing what exists tells you what you can reasonably ask for.

Projects5#

Read, create, update and search the projects in a workspace.

list_projectsList 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
NameTypeRequiredDescription
pageintegerNoPage number for pagination
limitintegerNoNumber of items per page
statusstringNoFilter projects by status (active, inactive, completed)
get_projectGet detailed information about a specific project.
NameTypeRequiredDescription
project_idstringYesProject numeric id or uniq_id (a task's project_uniq_id resolves here)
create_projectCreate a new project with specified details including name, description, and dates.
NameTypeRequiredDescription
namestringYesThe name of the project
descriptionstringNoThe description of the project
start_datestringNoProject start date in YYYY-MM-DD format
end_datestringNoProject end date in YYYY-MM-DD format
statusstringNoProject status (Started, Hold, Stack, Completed)
update_projectUpdate an existing project.
NameTypeRequiredDescription
project_idintegerYesThe ID of the project to update
namestringNoNew project name
descriptionstringNoNew project description
start_datestringNoStart date in YYYY-MM-DD format
end_datestringNoEnd date in YYYY-MM-DD format
statusstringNoProject status (Started, Hold, Stack, Completed)
search_projectsSearch the projects the caller can see by free-text query and optional filters.
NameTypeRequiredDescription
qstringNoFree-text query matching project name, short_name, or description
statusstringNoFilter by project status (active, inactive, completed)
status_group_idintegerNoFilter by status group ID
owner_idintegerNoFilter by project owner user ID
start_datestringNoFilter projects starting on or after this date (YYYY-MM-DD)
end_datestringNoFilter projects ending on or before this date (YYYY-MM-DD)
pageintegerNoPage number for pagination (default 1)
limitintegerNoNumber of items per page (default 15, max 100)

Tasks8#

List, read, create and update tasks, and look up the statuses and types a project accepts.

list_tasksList tasks with optional filtering by project ID, user ID, status, and pagination.
NameTypeRequiredDescription
project_idintegerNoFilter tasks by project ID
user_idintegerNoFilter tasks by user ID
statusstringNoFilter tasks by status: pending, in_progress, completed, cancelled
pageintegerNoPage number for pagination. Omit to return all matching tasks (up to 200).
limitintegerNoItems per page (1-100). Omit to return all matching tasks (up to 200) instead of a single page.
get_taskGet 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.
NameTypeRequiredDescription
task_idstringYesTask numeric id or uniq_id (both are returned by list_tasks/search_tasks/get_task)
create_taskCreate a new task in a project with specified details including title, description, priority, and assignment.
NameTypeRequiredDescription
project_idstringYesProject numeric id or uniq_id
titlestringYesThe title of the task
descriptionstringNoThe description of the task (supports HTML)
assigned_tointegerNoUser ID to assign the task to
prioritystringNoPriority: low, medium or high
estimated_hoursnumberNoEstimated effort in hours (decimal, e.g. 2 or 1.5)
type_idintegerNoTask type id (e.g. Bug, Task, Story). Defaults to the project's Bug type when omitted.
epic_idintegerNoEpic id to link this task under (optional)
feature_idintegerNoFeature id to link this task under (optional, v4 projects)
story_pointsintegerNoStory points — agile estimate (optional)
start_datestringNoTask start date in YYYY-MM-DD format (optional)
due_datestringNoTask due (end) date in YYYY-MM-DD format (optional)
update_taskUpdate an existing task.
NameTypeRequiredDescription
task_idstringYesTask numeric id or uniq_id (both are returned by list_tasks/search_tasks/get_task)
titlestringNoNew task title
descriptionstringNoNew task description (supports HTML)
statusstringNoWorkflow status name, exactly as configured for the project, e.g. "Dev Completed" or "Closed". Call list_task_statuses for the project's valid values. On projects with no status workflow the generic statuses new, in_progress, resolved, closed are accepted instead (aliases such as pending/started/resolve/completed also work).
custom_status_idintegerNoWorkflow status by numeric id, as returned by list_task_statuses. Alternative to status.
prioritystringNoPriority: low, medium or high
assigned_tointegerNoUser ID to assign the task to
estimated_hoursnumberNoEstimated effort in hours (decimal, e.g. 2 or 1.5)
type_idintegerNoTask type id (e.g. Bug, Task, Story)
epic_idintegerNoEpic id to link this task under (0 to unlink)
feature_idintegerNoFeature id to link this task under (0 to unlink, v4 projects)
story_pointsintegerNoStory points — agile estimate
start_datestringNoTask start date in YYYY-MM-DD format (optional)
due_datestringNoDue (end) date in YYYY-MM-DD format (optional)
search_tasksSearch tasks by free-text query and optional filters (project, status, priority, assignee).
NameTypeRequiredDescription
qstringNoFree-text search query matching task title/description
project_idintegerNoFilter tasks by project ID
statusstringNoFilter tasks by status: pending, in_progress, completed, cancelled
prioritystringNoFilter tasks by priority: low, medium or high
assigned_tointegerNoFilter tasks assigned to a specific user ID
pageintegerNoPage number for pagination. Omit to return all matching tasks (up to 200).
limitintegerNoItems per page (1-100). Omit to return all matching tasks (up to 200) instead of a single page.
list_task_statusesList the workflow statuses configured for a project, in workflow order.
NameTypeRequiredDescription
project_idstringYesProject numeric id or uniq_id
list_task_typesList the task types available in the workspace (e.g. Bug, Task, Story, Epic, Feature) with their numeric ids.
NameTypeRequiredDescription
project_idstringNoOptional project numeric id or uniq_id — includes types defined for that project in addition to the workspace-wide ones
list_tasks_v2List tasks with strict project filtering, sprint/mine/status filters, deterministic pagination, and normalized identifiers.
NameTypeRequiredDescription
project_idintegerNoStrict numeric project filter
sprint_idstringNoSprint numeric id or uniq_id: only tasks in this sprint
minebooleanNoWhen true, tasks assigned to the authenticated user only
statusstringNoStatus filter as CSV or array values: open,in_progress,pending,closed,completed,cancelled
pageintegerNoPage number (default 1)
limitintegerNoItems per page (default 20, max 100)

Task comments4#

Read and post comments on a task. Posting does not send the notifications the web app would.

list_task_commentsList the comments on a task, newest first, paginated.
NameTypeRequiredDescription
task_idstringYesTask numeric id or uniq_id (both are returned by list_tasks/search_tasks/get_task)
pageintegerNoPage number for pagination (default 1)
limitintegerNoNumber of comments per page (default
get_task_commentGet a single comment on a task, with its body unclipped.
NameTypeRequiredDescription
task_idstringYesTask numeric id or uniq_id
comment_idintegerYesComment id, as returned by get_task / list_task_comments
add_task_commentPost a comment on a task as the authenticated user.
NameTypeRequiredDescription
task_idstringYesTask numeric id or uniq_id
bodystringYesThe comment text
update_task_commentEdit a comment on a task, replacing its body.
NameTypeRequiredDescription
task_idstringYesTask numeric id or uniq_id
comment_idintegerYesComment id, as returned by get_task / list_task_comments
bodystringYesThe replacement comment text

Dependencies, links and labels9#

Scheduling dependencies between tasks, plain links, and labels.

list_task_dependenciesList 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.
NameTypeRequiredDescription
task_idstringYesTask numeric id or uniq_id
add_task_dependencyMake a task depend on another task (blocked-by): the task named in task_id waits on the task named in depends_on_task_id.
NameTypeRequiredDescription
task_idstringYesThe dependent task (the one that waits) — numeric id or uniq_id
depends_on_task_idstringYesThe prerequisite task (the one waited on) — numeric id or uniq_id
typestringNofinish-to-start (default), start-to-start, finish-to-finish or start-to-finish; FS/SS/FF/SF also accepted
update_task_dependencyChange 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).
NameTypeRequiredDescription
task_idstringYesThe dependent task (the one that waits) — numeric id or uniq_id
depends_on_task_idstringYesThe prerequisite task (the one waited on) — numeric id or uniq_id
typestringYesfinish-to-start, start-to-start, finish-to-finish or start-to-finish
list_task_linksList 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.
NameTypeRequiredDescription
task_idstringYesTask numeric id or uniq_id
add_task_linkLink one task to another (a "related to" / "duplicated by" style relation, with no scheduling meaning — use add_task_dependency for that).
NameTypeRequiredDescription
task_idstringYesThe task the link is made from — numeric id or uniq_id
target_task_idstringYesThe task being linked to — numeric id or uniq_id
relationstringNoRelation slug, e.g. related-to or duplicated-by (see list_task_links)
list_task_labelsList the labels on a task and the active labels available to its project (project labels plus company-wide ones).
NameTypeRequiredDescription
task_idstringYesTask numeric id or uniq_id
add_task_labelsAdd labels to a task.
NameTypeRequiredDescription
task_idstringYesTask numeric id or uniq_id
labelsarrayYesLabel names or label ids
remove_task_labelRemove one label from a task, by label id or name.
NameTypeRequiredDescription
task_idstringYesTask numeric id or uniq_id
labelstringYesLabel id or name
update_task_linkChange the relation of an existing link between two tasks — e.g. from related-to to duplicated-by.
NameTypeRequiredDescription
task_idstringYesThe task the link was made from — numeric id or uniq_id
link_idintegerYesThe link row id, as reported by get_task / list_task_links
relationstringYesNew relation slug, e.g. related-to or duplicated-by

Cross-project linking5#

Relations that span projects: the cross-project board, program flow, a task's relations across projects, and pickers for link targets.

get_cross_project_boardGet 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.
NameTypeRequiredDescription
project_idsarrayNoOptional project numeric ids or uniq_ids to narrow the board to; projects you cannot access are ignored
limit_per_columnintegerNoCards per column, 1-100 (default 25)
get_program_flowGet 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.
NameTypeRequiredDescription
program_idstringYesProgram numeric id or uniq_id (a project whose purpose is program)
list_cross_project_relationsList 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.
NameTypeRequiredDescription
task_idstringYesWork item numeric id or uniq_id
list_linkable_projectsList the projects you may link a work item into or pick a dependency from: active projects you can access, programs excluded, ordered by name.
NameTypeRequiredDescription
current_project_idstringNoOptional project numeric id or uniq_id to flag as the current one
search_link_targetsFind 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).
NameTypeRequiredDescription
kindstringNolink (default) or dependency
project_idstringNoProject numeric id or uniq_id to search, or "all" (default) for every project you can access
task_idstringNoOptional source work item (numeric id or uniq_id) the target is for
searchstringNo"#123" for a work item number, or part of a title
limitintegerNoResults, 1-25 (default 10)

Attachments1#

Files attached anywhere in a task's comment thread.

list_task_attachmentsList the files attached to a task, newest first, paginated.
NameTypeRequiredDescription
task_idstringYesTask numeric id or uniq_id (both are returned by list_tasks/search_tasks/get_task)
pageintegerNoPage number for pagination (default 1)
limitintegerNoNumber of files per page (default

Backlog hierarchy5#

Epics, features, stories and subtasks. Orangescrum v4 projects only.

get_epicGet an Epic and the full hierarchy beneath it: its Features, the Stories under each Feature, and the tasks (and their subtasks) under each Story.
NameTypeRequiredDescription
epic_idstringYesEpic numeric id or uniq_id
include_treebooleanNoSet false for the Epic and its counts only, without the descendants (default true)
create_epicCreate an Epic, the top-level Scrum backlog item, in a project.
NameTypeRequiredDescription
project_idstringYesProject numeric id or uniq_id
titlestringYesEpic title
descriptionstringNoEpic description
assigned_tointegerNoUser ID to assign the epic to
prioritystringNoPriority: low, medium or high
due_datestringNoDue date in YYYY-MM-DD format
story_pointintegerNoStory points
create_featureCreate a Feature under an existing Epic.
NameTypeRequiredDescription
epic_idintegerYesThe ID of the parent Epic
titlestringYesFeature title
descriptionstringNoFeature description
assigned_tointegerNoUser ID to assign the feature to
prioritystringNoPriority: low, medium or high
due_datestringNoDue date in YYYY-MM-DD format
story_pointintegerNoStory points
create_storyCreate a Story in a project.
NameTypeRequiredDescription
project_idstringYesProject numeric id or uniq_id
titlestringYesStory title
feature_idintegerNoOptional parent Feature ID; inherits that Feature's Epic
epic_idintegerNoOptional parent Epic ID (ignored if feature_id is given)
descriptionstringNoStory description
assigned_tointegerNoUser ID to assign the story to
prioritystringNoPriority: low, medium or high
due_datestringNoDue date in YYYY-MM-DD format
story_pointintegerNoStory points
create_subtaskCreate a child work-item under a Story or a Task.
NameTypeRequiredDescription
parent_task_idstringYesParent Story or Task numeric id or uniq_id (both are returned by list_tasks/get_task)
titlestringYesTitle of the child item
type_idintegerNoOptional type ID; defaults to the parent's type
descriptionstringNoDescription (supports HTML)
assigned_tointegerNoUser ID to assign to
prioritystringNoPriority: low, medium or high
estimated_hoursnumberNoEstimated effort in hours (decimal, e.g. 2 or 1.5)
start_datestringNoStart date in YYYY-MM-DD format (optional)
due_datestringNoDue date in YYYY-MM-DD format
story_pointintegerNoStory points

Sprints7#

Create, start and complete sprints, and move work in and out of them.

list_sprintsList sprints for a project.
NameTypeRequiredDescription
project_idstringYesProject numeric id or uniq_id
statusstringNoWhich sprints to return: active (default), completed, or all
get_sprintGet a single sprint by its numeric id or uniq_id.
NameTypeRequiredDescription
sprint_idstringYesSprint numeric id or uniq_id
create_sprintCreate a new sprint (also called a milestone, iteration or release) with a name in a project.
NameTypeRequiredDescription
project_idstringYesProject numeric id or uniq_id
titlestringYesSprint title (must be unique within the project)
descriptionstringNoSprint goal / description
start_datestringNoPlanned start date in YYYY-MM-DD format
end_datestringNoPlanned end date in YYYY-MM-DD format
update_sprintUpdate a sprint's title, description, or planned dates.
NameTypeRequiredDescription
sprint_idstringYesSprint numeric id or uniq_id
titlestringNoNew sprint title (must be unique within the project)
descriptionstringNoNew sprint goal / description
start_datestringNoPlanned start date in YYYY-MM-DD format (empty string clears it)
end_datestringNoPlanned end date in YYYY-MM-DD format (empty string clears it)
start_sprintStart a sprint.
NameTypeRequiredDescription
sprint_idstringYesSprint numeric id or uniq_id
start_datestringNoSprint start date in YYYY-MM-DD format (must accompany end_date)
end_datestringNoSprint end date in YYYY-MM-DD format (must accompany start_date)
titlestringNoOptionally rename the sprint on start
descriptionstringNoOptionally set the sprint goal on start
complete_sprintComplete (close) a sprint.
NameTypeRequiredDescription
sprint_idstringYesSprint numeric id or uniq_id
incomplete_destinationstringNoWhere to send incomplete tasks: "backlog" (default) or "next_sprint:<id>" to move them to another active sprint in the same project
assign_task_to_sprintMove a task into a sprint, or back to the backlog.
NameTypeRequiredDescription
task_idstringYesTask numeric id or uniq_id (must be a top-level task, not a subtask)
sprint_idstringNoTarget sprint numeric id or uniq_id; omit or leave empty to move the task to the backlog
positionintegerNoOptional 0-based order of the task within the sprint

Timelogs3#

Log time against tasks and read it back.

list_timelogsList timelogs for the authenticated partner user, with optional filters by project, task, and date range.
NameTypeRequiredDescription
project_idintegerNoFilter timelogs by project ID
task_idintegerNoFilter timelogs by task ID
fromstringNoStart date (YYYY-MM-DD) — inclusive
tostringNoEnd date (YYYY-MM-DD) — inclusive
pageintegerNoPage number for pagination (default 1)
limitintegerNoNumber of items per page (default 20, max 100)
create_timelogLog time against a task.
NameTypeRequiredDescription
project_idintegerYesProject ID the time is logged against
task_idintegerNoTask ID the time is logged against (optional)
task_datestringYesDate of the work in YYYY-MM-DD format
descriptionstringYesDescription of the work done
total_hoursnumberNoTotal hours spent (decimal; e.g., 2.5 for two and a half hours)
start_timestringNoStart time in HH:MM:SS format (optional, overrides total_hours synthesis)
end_timestringNoEnd time in HH:MM:SS format (optional, overrides total_hours synthesis)
is_billablebooleanNoWhether the time is billable (default false)
update_timelogUpdate a timelog entry.
NameTypeRequiredDescription
timelog_idstringYesTimelog id — the uniq_id returned by create_timelog/list_timelogs (a numeric log id is also accepted)
task_datestringNoDate of the work in YYYY-MM-DD format
descriptionstringNoDescription of the work done
total_hoursnumberNoTotal hours spent (decimal)
start_timestringNoStart time in HH:MM:SS format
end_timestringNoEnd time in HH:MM:SS format
is_billablebooleanNoWhether the time is billable

Users3#

The connected user and the workspace directory.

get_current_userReturn authenticated user profile including timezone, roles, and default workspace/company

This tool takes no arguments.

list_usersList users in the company with optional free-text search on name/email and pagination.
NameTypeRequiredDescription
searchstringNoFree-text match on user name or email (case-insensitive)
pageintegerNoPage number for pagination (default 1)
limitintegerNoNumber of items per page (default 20, max 100)
get_userGet detailed information about a specific user.
NameTypeRequiredDescription
user_idstringYesUser numeric id or uniq_id (both are returned by list_users/get_user)

Project context ("memory")2#

Standing instructions the assistant reads at the start of a conversation.

get_project_contextRetrieve the standing context ("memory") saved for this workspace — background, conventions, and instructions to keep in mind.
NameTypeRequiredDescription
project_idstringNoOptional project numeric id or uniq_id
add_project_contextSave a standing context ("memory") entry so it is recalled in future conversations.
NameTypeRequiredDescription
titlestringYesShort label for the entry
bodystringYesThe fact, convention, or instruction to remember
project_idstringNoOptional project numeric id or uniq_id; omit for company-wide

Document search1#

Semantic search over documents uploaded to the workspace.

search_documentsSearch documents uploaded to this Orangescrum workspace (PDFs, Word, Excel, images) by meaning and return the most relevant excerpts with their source document.
NameTypeRequiredDescription
querystringYesWhat to look for, in natural language
project_idintegerNoOptional project id to scope the search to one project
limitintegerNoMaximum excerpts to return (1-20, default 5)

Knowledge Base: Library, books and search8#

Find books and pages, read page trees, bodies, backlinks and attachments, and run ranked search.

list_wiki_libraryList 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.
NameTypeRequiredDescription
shelf_idintegerNoOnly books on this shelf
searchstringNoText to find in book names
get_wiki_bookGet 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.
NameTypeRequiredDescription
book_idintegerYesBook (wiki space) id from list_wiki_library
get_wiki_book_treeGet 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.
NameTypeRequiredDescription
book_idintegerYesBook (wiki space) id from list_wiki_library
get_wiki_pageRead 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.
NameTypeRequiredDescription
page_idintegerYesKnowledge Base page id (page_id from list or search results)
formatstringNohtml (default): the stored body; text: plain text, shorter
search_wiki_pagesSearch the Knowledge Base pages you can see.
NameTypeRequiredDescription
querystringNoWords to search for
book_idintegerNoOnly pages in this book
labelstringNoOnly pages carrying this label
contributor_idintegerNoOnly pages created or last edited by this member
daysintegerNoOnly pages updated in the last N days
limitintegerNoMaximum results (default 20, max 60)
list_wiki_backlinksList the Knowledge Base pages whose body links to this page (backlinks), in any book you can see.
NameTypeRequiredDescription
page_idintegerYesKnowledge Base page id (page_id from list or search results)
list_wiki_page_attachmentsList 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.
NameTypeRequiredDescription
page_idintegerYesKnowledge Base page id (page_id from list or search results)
list_wiki_pages_for_targetList 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.
NameTypeRequiredDescription
target_typestringYeswork_item, project or program
target_idstringYesNumeric id of the work item, project or program; a work item's uniq_id also works

Knowledge Base: Writing pages7#

Create, edit, move, copy, archive and restore pages and folders.

create_wiki_pageCreate a Knowledge Base page (or a folder to group pages) in a book, at the top level or under a parent page.
NameTypeRequiredDescription
book_idintegerYesBook (wiki space) id from list_wiki_library
titlestringNoPage title (required for a folder; "Untitled" when left out)
contentstringNoPage body
content_formatstringNomarkdown (default) or html. Either way the body is sanitized to the Knowledge Base allow-list.
parent_idintegerNoCreate under this page or folder of the same book; omit for the top level
node_typestringNopage (default) or folder
pub_statestringNodraft (default), published or obsolete
iconstringNoOne emoji
descriptionstringNoShort summary (max 500 characters)
labelsarrayNoLabels (tags); replaces the existing set
update_wiki_pageChange a Knowledge Base page: title, body, labels, properties (frontmatter), icon, description or publication state.
NameTypeRequiredDescription
page_idintegerYesKnowledge Base page id (page_id from list or search results)
titlestringNoNew title
contentstringNoNew body, replacing the current one
content_formatstringNomarkdown (default) or html. Either way the body is sanitized to the Knowledge Base allow-list.
revision_notestringNoNote stored with the replaced version
pub_statestringNodraft, published or obsolete
iconstringNoOne emoji; empty to clear
descriptionstringNoShort summary; empty to clear
labelsarrayNoLabels (tags); replaces the existing set
frontmatterobjectNoPage properties as key/value text pairs (max 30); replaces the existing set
move_wiki_pageMove 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).
NameTypeRequiredDescription
page_idintegerYesKnowledge Base page id (page_id from list or search results)
parent_idintegerNoNew parent page or folder
book_idintegerNoDestination book; alone, moves the page to that book's top level
positionintegerNoPosition among the new siblings, 0 first; default last
copy_wiki_pageDuplicate a Knowledge Base page next to itself as a draft titled "… (copy)", with its body, labels and properties but a fresh history.
NameTypeRequiredDescription
page_idintegerYesKnowledge Base page id (page_id from list or search results)
archive_wiki_pageArchive (delete) a Knowledge Base page or an empty folder.
NameTypeRequiredDescription
page_idintegerYesKnowledge Base page id (page_id from list or search results)
list_archived_wiki_pagesList archived (deleted) Knowledge Base pages, most recently archived first, so one can be brought back with restore_wiki_page.
NameTypeRequiredDescription
book_idintegerNoOnly pages from this book
pageintegerNoPage number (default 1)
limitintegerNoResults per page (default 25, max 100)
restore_wiki_pageBring back an archived Knowledge Base page (see list_archived_wiki_pages).
NameTypeRequiredDescription
page_idintegerYesKnowledge Base page id (page_id from list or search results)

Knowledge Base: History4#

Page revisions: list, read, save a named version and restore one.

list_wiki_page_revisionsList 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.
NameTypeRequiredDescription
page_idintegerYesKnowledge Base page id (page_id from list or search results)
limitintegerNoHow many revisions (default and max 50)
get_wiki_page_revisionRead one saved version of a Knowledge Base page, with its body (HTML, or plain text with format=text), title, note and author.
NameTypeRequiredDescription
revision_idintegerYesRevision id from list_wiki_page_revisions
formatstringNohtml (default): the stored body; text: plain text, shorter
save_wiki_page_versionSave the current title and body of a Knowledge Base page as a named version in its history, without changing the page.
NameTypeRequiredDescription
page_idintegerYesKnowledge Base page id (page_id from list or search results)
notestringNoWhat this version is, e.g. "Before Q4 rewrite"
restore_wiki_page_revisionPut an older version's body back on its Knowledge Base page.
NameTypeRequiredDescription
revision_idintegerYesRevision id from list_wiki_page_revisions

Knowledge Base: Comments, action items, review and links13#

Comment and resolve, manage action items, request and decide reviews, watch pages, and link pages to work items, projects and programs.

list_wiki_page_commentsList 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.
NameTypeRequiredDescription
page_idintegerYesKnowledge Base page id (page_id from list or search results)
unresolved_onlybooleanNoLeave out resolved comments
pageintegerNoPage number (default 1)
limitintegerNoComments per page (default 50, max 100)
add_wiki_commentPost a comment on a Knowledge Base page.
NameTypeRequiredDescription
page_idintegerYesKnowledge Base page id (page_id from list or search results)
bodystringYesComment text
body_formatstringNomarkdown (default) or html
mention_user_idsarrayNoMembers to @mention
resolve_wiki_commentMark a Knowledge Base page comment resolved, or open again with resolved=false.
NameTypeRequiredDescription
comment_idintegerYesComment id from list_wiki_page_comments
resolvedbooleanNotrue (default) to resolve, false to reopen
list_wiki_action_itemsList 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).
NameTypeRequiredDescription
scopestringNopage, book, mine (default) or open
page_idintegerNoPage id, for scope=page
book_idintegerNoBook id, for scope=book
open_onlybooleanNoLeave out finished items
save_wiki_action_itemAdd 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.
NameTypeRequiredDescription
action_item_idintegerNoExisting action item to change; omit to create
page_idintegerNoPage the item belongs to (required to create)
textstringNoWhat needs doing (max 500 characters)
assignee_idintegerNoMember responsible; 0 to unassign
due_datestringNoDue date, YYYY-MM-DD; empty to clear
positionintegerNoOrder on the page
set_wiki_action_item_doneMark a Knowledge Base action item done, or open again with done=false.
NameTypeRequiredDescription
action_item_idintegerYesAction item id
donebooleanNotrue (default) for done, false to reopen
delete_wiki_action_itemDelete an action item from a Knowledge Base page for good.
NameTypeRequiredDescription
action_item_idintegerYesAction item id
get_wiki_reviewGet 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.
NameTypeRequiredDescription
page_idintegerYesKnowledge Base page id (page_id from list or search results)
request_wiki_reviewSend a Knowledge Base page to a reviewer: the page shows "in review" and the reviewer is notified.
NameTypeRequiredDescription
page_idintegerYesKnowledge Base page id (page_id from list or search results)
reviewer_idintegerYesMember who reviews the page
notestringNoNote for the reviewer
decide_wiki_reviewDecide a Knowledge Base page review: approve (which publishes the page) or request_changes, with an optional note for the author, who is notified.
NameTypeRequiredDescription
page_idintegerYesKnowledge Base page id (page_id from list or search results)
decisionstringYesapprove or request_changes
notestringNoNote for the author
watch_wiki_pageWatch 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).
NameTypeRequiredDescription
page_idintegerYesKnowledge Base page id (page_id from list or search results)
scopestringNopage (default), subtree or space
watchbooleanNotrue (default) to watch, false to stop
frequencystringNoimmediate (default), daily, weekly or off
link_wiki_pageLink 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.
NameTypeRequiredDescription
page_idintegerYesKnowledge Base page id (page_id from list or search results)
target_typestringYeswork_item, project or program
target_idstringYesNumeric id of the work item, project or program; a work item's uniq_id also works
unlink_wiki_pageRemove the link between a Knowledge Base page and a work item, project or program.
NameTypeRequiredDescription
page_idintegerYesKnowledge Base page id (page_id from list or search results)
target_typestringYeswork_item, project or program
target_idstringYesNumeric id of the work item, project or program; a work item's uniq_id also works

Knowledge Base: Books and shelves4#

Create, edit and archive books and shelves.

save_wiki_bookCreate 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).
NameTypeRequiredDescription
book_idintegerNoExisting book to change; omit to create
namestringNoBook name (required to create)
descriptionstringNoWhat the book holds
iconstringNoOne emoji
cover_colorstringNoCover colour as #RRGGBB
project_idintegerNoProject the book belongs to; 0 for none
shelf_idintegerNoShelf to put the book on; 0 for none
archive_wiki_bookArchive a Knowledge Base book.
NameTypeRequiredDescription
book_idintegerYesBook (wiki space) id from list_wiki_library
save_wiki_shelfCreate a Knowledge Base shelf to group books, or change one by passing shelf_id: name, description or icon.
NameTypeRequiredDescription
shelf_idintegerNoExisting shelf to change; omit to create
namestringNoShelf name (required to create)
descriptionstringNoWhat the shelf groups
iconstringNoOne emoji
archive_wiki_shelfArchive a Knowledge Base shelf.
NameTypeRequiredDescription
shelf_idintegerYesShelf id from list_wiki_library

Test Lab: Repository20#

Test cases, suites, datasets, shared steps and custom fields.

list_test_lookupsList 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.

This tool takes no arguments.

create_test_caseCreate a test case in the Test Lab repository (/test-lab#/repository) of a project.
NameTypeRequiredDescription
project_idstringYesProject id or uniq_id
titlestringYesCase title (max 500 chars)
list_test_casesList Test Lab test cases (the /test-lab#/repository list), ordered by project and TC number.
NameTypeRequiredDescription
project_idstringNoProject id or uniq_id; omit for all your projects
suite_idintegerNoSuite id (includes its sub-suites); 0 for unassigned cases
prioritystringNoComma-separated priorities, e.g. high,critical
typestringNoComma-separated types
statestringNoComma-separated states: draft, in_review, active, deprecated
automation_statusstringNoComma-separated: manual, to_automate, automated
scenario_idintegerNoOnly cases in this scenario
owner_idintegerNoOnly cases owned by this user id
searchstringNoMatches title, steps or tags; a number also matches the TC number
tagstringNoExact tag
pageintegerNoPage (default 1)
limitintegerNoPer page (default 50, max 200)
get_test_caseGet a Test Lab test case with all its fields and steps, plus its links (tasks, cases, defects, runs), comments, attachments and latest run results.
NameTypeRequiredDescription
test_case_idintegerYesTest case id
update_test_caseUpdate a Test Lab test case.
NameTypeRequiredDescription
test_case_idintegerYesTest case id (the number behind TC-n is case_no; use the id from list/get)
titlestringNoCase title (max 500 chars)
delete_test_caseDelete a Test Lab test case.
NameTypeRequiredDescription
test_case_idintegerYesTest case id
list_test_case_versionsVersion history of a Test Lab test case, newest first (up to 30).
NameTypeRequiredDescription
test_case_idintegerYesTest case id
list_test_suitesList the Test Lab suites (the folder tree of the repository) of a project, with parent ids and case counts.
NameTypeRequiredDescription
project_idstringYesProject id or uniq_id
create_test_suiteCreate a test suite (a folder in the Test Lab repository, /test-lab#/repository) in a project, optionally inside a parent suite.
NameTypeRequiredDescription
project_idstringYesProject id or uniq_id
namestringYesSuite name
descriptionstringNoDescription
parent_idintegerNoParent suite id; 0 for top level
update_test_suiteRename a Test Lab suite, change its description, or move it under another suite of the same project.
NameTypeRequiredDescription
suite_idintegerYesSuite id (from list_test_suites)
namestringNoNew name
descriptionstringNoDescription
parent_idintegerNoParent suite id; 0 for top level
list_test_datasetsList the parameter datasets a project can use (its own plus workspace-wide).
NameTypeRequiredDescription
project_idstringYesProject id or uniq_id
add_test_case_tagsAdd tags to one or more Test Lab test cases (like the Add tag bulk action).
NameTypeRequiredDescription
test_case_idsarrayYesTest case ids
tagsarrayYesTags to add
export_test_casesExport 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, ...).
NameTypeRequiredDescription
project_idstringNoProject id or uniq_id; omit for all your projects
test_case_idsarrayNoExport exactly these cases
suite_idintegerNoSuite (with sub-suites); 0 for unassigned
prioritystringNoComma-separated
typestringNoComma-separated
statestringNoComma-separated
automation_statusstringNoComma-separated
scenario_idintegerNoScenario id
columnsarrayNoColumns to include (default all): case_no, title, description, priority, type, state, automation_status, automation_ref, tags, last_status, preconditions, steps, expected_result, suite, scenario, owner, estimate_min, version, created, modified
create_test_datasetCreate a Test Lab parameter dataset: named columns and rows of values.
NameTypeRequiredDescription
namestringYesDataset name
project_idstringNoProject id or uniq_id; omit for a workspace-wide dataset
descriptionstringNoDescription
columnsarrayYesColumn names, used as {name} placeholders in cases (letters, digits, _ . -)
rowsarrayNoRows as objects keyed by column, e.g. [{"username": "alice"}]. Replaces all rows
update_test_datasetUpdate a Test Lab dataset: rename, change description or project, or replace its columns and rows.
NameTypeRequiredDescription
dataset_idintegerYesDataset id (from list_test_datasets)
namestringNoDataset name
descriptionstringNoDescription
project_idstringNoProject id or uniq_id; empty for workspace-wide
columnsarrayNoColumn names, used as {name} placeholders in cases (letters, digits, _ . -)
rowsarrayNoRows as objects keyed by column, e.g. [{"username": "alice"}]. Replaces all rows
list_test_shared_stepsList Test Lab shared steps: reusable step blocks a project's cases can copy in.
NameTypeRequiredDescription
project_idstringNoProject id or uniq_id; omit for all your projects
update_test_shared_stepEdit a Test Lab shared step block: rename it or replace its steps.
NameTypeRequiredDescription
shared_step_idintegerYesShared step id (from list_test_shared_steps)
titlestringNoTitle
stepsarrayNoOrdered steps: strings or {"step": "...", "expected": "..."}. Replaces the whole list
list_test_custom_fieldsList the Test Lab custom field definitions (workspace-wide) for test cases and / or defects, with their keys, types and options.
NameTypeRequiredDescription
entitystringNocase or defect; omit for both
create_test_custom_fieldCreate a Test Lab custom field for test cases or defects (workspace-wide).
NameTypeRequiredDescription
entitystringYescase or defect
labelstringYesLabel shown in Test Lab; the field key is derived from it on create
typestringNotext, textarea, select, multiselect, number, date, checkbox, url or user
optionsarrayNoChoices for select / multiselect
is_requiredbooleanNoRequired in the Test Lab form
is_visiblebooleanNoShown in the form (default true)
sort_orderintegerNoDisplay order
update_test_custom_fieldEdit a Test Lab custom field: label, type, options, required, visible or order.
NameTypeRequiredDescription
field_idintegerYesField id (from list_test_custom_fields)
labelstringNoLabel shown in Test Lab; the field key is derived from it on create
typestringNotext, textarea, select, multiselect, number, date, checkbox, url or user
optionsarrayNoChoices for select / multiselect
is_requiredbooleanNoRequired in the Test Lab form
is_visiblebooleanNoShown in the form (default true)
sort_orderintegerNoDisplay order

Comments, links and attachments on cases, defects and runs.

list_test_commentsList comments on a Test Lab test case, defect or run (oldest first).
NameTypeRequiredDescription
entity_typestringYescase, defect or run
entity_idintegerYesId of that record
add_test_commentAdd a comment to a Test Lab test case, defect or run (max 8000 chars).
NameTypeRequiredDescription
entity_typestringYescase, defect or run
entity_idintegerYesId of that record
bodystringYesComment text
add_test_linkLink a Test Lab test case or defect to an Orangescrum task, another test case, a defect or a run.
NameTypeRequiredDescription
entity_typestringYescase or defect
entity_idintegerYesId of the case or defect
target_typestringYesworkitem (an Orangescrum task), case, defect or run
target_idstringYesTarget id; for a workitem the task id or uniq_id
remove_test_linkRemove a Test Lab link by its link id (shown in get_test_case / get_defect links).
NameTypeRequiredDescription
link_idintegerYesLink id
list_test_attachmentsList 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).
NameTypeRequiredDescription
entity_typestringYescase, defect, scenario or result
entity_idintegerYesId of that record (for result: the run result id)

Test Lab: Scenarios and strategies12#

Scenarios that group cases, and strategies that group scenarios.

list_test_scenariosList Test Lab scenario records (the /test-lab#/scenarios screen) with their child counts.
NameTypeRequiredDescription
project_idstringNoProject id or uniq_id; omit for all your projects
statestringNoComma-separated states
searchstringNoMatches title, description or number
prioritystringNoComma-separated priorities
strategy_idintegerNoOnly scenarios in this strategy
pageintegerNoPage (default 1)
limitintegerNoPer page (default 50)
get_test_scenarioGet a Test Lab test scenario with its cases.
NameTypeRequiredDescription
scenario_idintegerYesScenario id
create_test_scenarioCreate a Test Lab test scenario in a project; it gets the next number in the project.
NameTypeRequiredDescription
project_idstringYesProject id or uniq_id
titlestringYesTitle
descriptionstringNoDescription
statestringNoState, e.g. draft, in_review, active, deprecated
owner_idstringNoOwner user id or uniq_id (active workspace member)
tagsarrayNoTags; replaces the list
suite_idintegerNoSuite id in the same project; 0 to clear
strategy_idintegerNoStrategy id in the same project; 0 to clear
gherkinstringNoGherkin text
prioritystringNoPriority, e.g. critical, high, medium, low
update_test_scenarioUpdate a Test Lab test scenario; only the fields you pass change.
NameTypeRequiredDescription
scenario_idintegerYesScenario id
titlestringNoTitle
descriptionstringNoDescription
statestringNoState, e.g. draft, in_review, active, deprecated
owner_idstringNoOwner user id or uniq_id (active workspace member)
tagsarrayNoTags; replaces the list
suite_idintegerNoSuite id in the same project; 0 to clear
strategy_idintegerNoStrategy id in the same project; 0 to clear
gherkinstringNoGherkin text
prioritystringNoPriority, e.g. critical, high, medium, low
delete_test_scenarioDelete a Test Lab test scenario (soft delete).
NameTypeRequiredDescription
scenario_idintegerYesScenario id
set_scenario_casesAttach test cases to a Test Lab test scenario (attach=true, default) or detach them (attach=false).
NameTypeRequiredDescription
scenario_idintegerYesScenario id
case_idsarrayYesTest case ids
attachbooleanNotrue to attach (default), false to detach
list_test_strategiesList Test Lab strategy records (the /test-lab#/strategies screen) with their child counts.
NameTypeRequiredDescription
project_idstringNoProject id or uniq_id; omit for all your projects
statestringNoComma-separated states
searchstringNoMatches title, description or number
plan_idintegerNoOnly strategies in this plan
pageintegerNoPage (default 1)
limitintegerNoPer page (default 50)
get_test_strategyGet a Test Lab test strategy with its scenarios.
NameTypeRequiredDescription
strategy_idintegerYesStrategy id
create_test_strategyCreate a Test Lab test strategy in a project; it gets the next number in the project.
NameTypeRequiredDescription
project_idstringYesProject id or uniq_id
titlestringYesTitle
descriptionstringNoDescription
statestringNoState, e.g. draft, in_review, active, deprecated
owner_idstringNoOwner user id or uniq_id (active workspace member)
tagsarrayNoTags; replaces the list
plan_idintegerNoTest plan id in the same project; 0 to clear
update_test_strategyUpdate a Test Lab test strategy; only the fields you pass change.
NameTypeRequiredDescription
strategy_idintegerYesStrategy id
titlestringNoTitle
descriptionstringNoDescription
statestringNoState, e.g. draft, in_review, active, deprecated
owner_idstringNoOwner user id or uniq_id (active workspace member)
tagsarrayNoTags; replaces the list
plan_idintegerNoTest plan id in the same project; 0 to clear
delete_test_strategyDelete a Test Lab test strategy (soft delete).
NameTypeRequiredDescription
strategy_idintegerYesStrategy id
set_strategy_scenariosAttach test scenarios to a Test Lab test strategy (attach=true, default) or detach them (attach=false).
NameTypeRequiredDescription
strategy_idintegerYesStrategy id
scenario_idsarrayYesTest scenario ids
attachbooleanNotrue to attach (default), false to detach

Test Lab: Plans and runs16#

Test plans, runs and recorded results.

get_test_run_setupList what a project's Test Lab runs and plans can use: configurations, environments and open sprints / milestones.
NameTypeRequiredDescription
project_idstringYesProject id or uniq_id
list_test_plansList Test Lab test plans (the /test-lab#/plans screen) with their case selection, configurations and run count.
NameTypeRequiredDescription
project_idstringNoProject id or uniq_id; omit for all your projects
get_test_planGet a Test Lab test plan with the runs it has launched and their progress.
NameTypeRequiredDescription
plan_idintegerYesPlan id
create_test_planCreate a Test Lab test plan: which cases to run (selection), against which configurations, for which sprint.
NameTypeRequiredDescription
project_idstringYesProject id or uniq_id
namestringYesPlan name
descriptionstringNoDescription
milestone_idstringNoSprint / milestone id or uniq_id; empty to clear
config_idsarrayNoConfiguration ids (get_test_run_setup); one run per configuration on launch
selectionobjectNoWhich cases a launch runs: {"mode": "all"|"cases"|"suites"|"filter", "case_ids": [..], "suite_ids": [..], "filter_priority": [..], "filter_automation": "manual"|"to_automate"|"automated"}
statusstringNodraft or active
update_test_planUpdate a Test Lab test plan; only the fields you pass change.
NameTypeRequiredDescription
plan_idintegerYesPlan id
namestringNoPlan name
descriptionstringNoDescription
milestone_idstringNoSprint / milestone id or uniq_id; empty to clear
config_idsarrayNoConfiguration ids (get_test_run_setup); one run per configuration on launch
selectionobjectNoWhich cases a launch runs: {"mode": "all"|"cases"|"suites"|"filter", "case_ids": [..], "suite_ids": [..], "filter_priority": [..], "filter_automation": "manual"|"to_automate"|"automated"}
statusstringNodraft or active
launch_test_planLaunch 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).
NameTypeRequiredDescription
plan_idintegerYesPlan id
delete_test_planDelete a Test Lab test plan (soft delete).
NameTypeRequiredDescription
plan_idintegerYesPlan id
list_test_runsList Test Lab runs (the /test-lab#/runs screen) with progress stats. source=exploratory lists exploratory sessions.
NameTypeRequiredDescription
project_idstringNoProject id or uniq_id; omit for all your projects
statusstringNoactive, completed or archived
sourcestringNomanual, automation or exploratory
plan_idintegerNoOnly runs launched from this plan
searchstringNoMatches the run name
pageintegerNoPage (default 1)
limitintegerNoPer page (default 50)
get_test_runGet 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.
NameTypeRequiredDescription
run_idintegerYesRun id
create_test_runStart a Test Lab run in a project.
NameTypeRequiredDescription
project_idstringYesProject id or uniq_id
namestringYesRun name
descriptionstringNoDescription
environmentstringNoEnvironment name (max 100)
milestone_idstringNoSprint / milestone id or uniq_id
assigned_tostringNoAssignee user id or uniq_id; every item is assigned to them
case_idsarrayNoRun exactly these cases
suite_idsarrayNoOr every case in these suites
filter_prioritystringNoNarrow by comma-separated priorities
filter_automationstringNoNarrow by manual, to_automate or automated
update_test_runRename a Test Lab run or change its description, environment, sprint or assignee.
NameTypeRequiredDescription
run_idintegerYesRun id
namestringNoRun name
descriptionstringNoDescription
environmentstringNoEnvironment name (max 100)
milestone_idstringNoSprint / milestone id or uniq_id
assigned_tostringNoAssignee user id or uniq_id; every item is assigned to them
record_test_resultRecord 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.
NameTypeRequiredDescription
item_idsarrayYesRun item ids (from get_test_run), all in one run
statusstringYesuntested, passed, failed, blocked, skipped or retest
commentstringNoResult comment
elapsed_secintegerNoTime spent, seconds
step_resultsarrayNoPer-step results for a single item: [{"i": 0, "status": "passed"}]
list_test_result_historyResult history of one Test Lab run item, newest first, with step results and any defect raised.
NameTypeRequiredDescription
item_idintegerYesRun item id
close_test_runClose (complete) a Test Lab run or end an exploratory session.
NameTypeRequiredDescription
run_idintegerYesRun id
rerun_failed_testsStart a new Test Lab run containing the failed and blocked items of an earlier run.
NameTypeRequiredDescription
run_idintegerYesRun id to rerun from
delete_test_runDelete a Test Lab run (soft delete).
NameTypeRequiredDescription
run_idintegerYesRun id

Test Lab: Exploratory sessions3#

Timed exploratory sessions and their notes.

start_exploratory_sessionStart a Test Lab exploratory session (the /test-lab#/explore screen): a run with a charter and no scripted items.
NameTypeRequiredDescription
project_idstringYesProject id or uniq_id
namestringYesSession name
charterstringNoCharter: what to explore and why
environmentstringNoEnvironment
add_exploratory_noteLog a finding in an active Test Lab exploratory session: a note, bug, idea or question.
NameTypeRequiredDescription
run_idintegerYesExploratory session (run) id
typestringYesnote, bug, idea or question
textstringYesWhat you found
list_exploratory_notesList the findings (notes, bugs, ideas, questions) of a Test Lab exploratory session.
NameTypeRequiredDescription
run_idintegerYesExploratory session (run) id

Test Lab: Baselines5#

Frozen snapshots of a project's test cases: compare and restore.

list_test_baselinesList Test Lab baselines (frozen snapshots of a project's test cases, the /test-lab#/baselines screen).
NameTypeRequiredDescription
project_idstringNoProject id or uniq_id; omit for all your projects
create_test_baselineFreeze 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.
NameTypeRequiredDescription
project_idstringYesProject id or uniq_id
namestringYesBaseline name, e.g. Release 4.2
descriptionstringNoDescription
suite_idintegerNoOnly this suite and its sub-suites
compare_test_baselineCompare 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.
NameTypeRequiredDescription
baseline_idintegerYesBaseline id
to_baseline_idintegerNoCompare with this baseline instead of the current cases
changed_onlybooleanNoLeave out unchanged cases
restore_test_baselineRestore test cases to their content in a Test Lab baseline.
NameTypeRequiredDescription
baseline_idintegerYesBaseline id
case_idsarrayYesTest case ids to restore
delete_test_baselineDelete a Test Lab baseline and its frozen cases (permanent, as in Test Lab).
NameTypeRequiredDescription
baseline_idintegerYesBaseline id

Test Lab: Defects8#

File, update and relate defects.

list_defectsList Test Lab defects (the /test-lab#/defects list), newest BUG number first.
NameTypeRequiredDescription
project_idstringNoProject id or uniq_id; omit for all your projects
statusstringNoComma-separated workflow statuses
severitystringNoComma-separated severities
prioritystringNoComma-separated priorities
resolutionstringNoComma-separated resolutions
assigned_tointegerNoAssignee user id
case_idintegerNoOnly defects raised against this test case
run_idintegerNoOnly defects raised in this run
open_onlybooleanNoOnly defects in an open-category status
searchstringNoMatches title or tags; a number also matches the BUG number
pageintegerNoPage (default 1)
limitintegerNoPer page (default 50, max 300)
get_defectGet a Test Lab defect with all its fields, related defects, watchers, change history, links (tasks, cases, runs), comments and attachments.
NameTypeRequiredDescription
defect_idintegerYesDefect id
create_defectReport a defect in Test Lab (/test-lab#/defects) for a project.
NameTypeRequiredDescription
project_idstringYesProject id or uniq_id
titlestringYesDefect title (max 500 chars)
statusstringNoInitial workflow status; default the first one (new). Closed statuses need a resolution
resolutionstringNoResolution, required when creating directly in a closed status
update_defectUpdate a Test Lab defect.
NameTypeRequiredDescription
defect_idintegerYesDefect id (from list_defects / get_defect)
titlestringNoDefect title (max 500 chars)
resolutionstringNoResolution
set_defect_statusMove a Test Lab defect to another workflow status (default new, open, in_progress, fixed, retest, verified, closed, rejected, duplicate).
NameTypeRequiredDescription
defect_idintegerYesDefect id
statusstringYesWorkflow status key, e.g. in_progress or closed (labels like "In Progress" also work)
resolutionstringNoResolution, required for closed statuses: fixed, wont_fix, duplicate, cannot_reproduce, works_as_designed
delete_defectDelete a Test Lab defect (soft delete, as in the Test Lab UI).
NameTypeRequiredDescription
defect_idintegerYesDefect id
add_defect_relationRelate two Test Lab defects: duplicate_of, relates, blocks or blocked_by.
NameTypeRequiredDescription
defect_idintegerYesDefect id
relationstringYesduplicate_of, relates, blocks or blocked_by
related_defect_idintegerNoOther defect id
related_defect_nointegerNoOr the other defect's BUG number in the same project
remove_defect_relationRemove a relation between two Test Lab defects by its relation id (from get_defect relations).
NameTypeRequiredDescription
relation_idintegerYesRelation id

Versions and releases: Versions, releases and approvals29#

Versions and releases, their items, progress, readiness, approval chains and release notes.

list_versionsList versions (planned product versions such as 4.2) in one project, or across every project you can access when project_id is omitted.
NameTypeRequiredDescription
project_idstringNoProject numeric id or uniq_id; omit for all your projects
statusstringNoOnly this status: Draft, Planned, Active, On Hold, Released or Archived
owner_idintegerNoOnly versions owned by this user id
searchstringNoMatches name or key
include_archivedbooleanNoInclude Archived versions (default false)
sortstringNoname, key, status, owner_id, planned_start_dt, planned_end_dt or created (default planned_end_dt)
directionstringNoasc or desc (default desc)
pageintegerNoPage number, from 1 (default 1)
limitintegerNoResults per page (default 25, max 100)
get_versionGet one version with its owner, dates, status, the statuses it can move to next, item and release counts, and its recent change history.
NameTypeRequiredDescription
version_idintegerYesVersion id (from list_versions)
create_versionCreate a version in a project.
NameTypeRequiredDescription
project_idstringYesProject numeric id or uniq_id
namestringYesVersion name, e.g. Spring release
keystringYesShort unique key in the project, e.g. v4.2
descriptionstringNoDescription
goalstringNoGoal of the version
owner_idstringNoOwner user id or uniq_id; must be an active member of the workspace; empty string clears it
planned_start_dtstringNoPlanned start date (YYYY-MM-DD; empty string clears it)
planned_end_dtstringNoPlanned end date, on or after the start date (YYYY-MM-DD; empty string clears it)
update_versionUpdate a version's name, description, goal, owner or planned dates.
NameTypeRequiredDescription
version_idintegerYesVersion id (from list_versions)
namestringNoVersion name
descriptionstringNoDescription
goalstringNoGoal of the version
owner_idstringNoOwner user id or uniq_id; must be an active member of the workspace; empty string clears it
planned_start_dtstringNoPlanned start date (YYYY-MM-DD; empty string clears it)
planned_end_dtstringNoPlanned end date, on or after the start date (YYYY-MM-DD; empty string clears it)
transition_versionMove a version to another status: Draft, Planned, Active, On Hold, Released or Archived.
NameTypeRequiredDescription
version_idintegerYesVersion id (from list_versions)
statusstringYesTarget status: Draft, Planned, Active, On Hold, Released or Archived
delete_versionDelete a version (soft delete, as the Delete button in the app; the plugin calls this archiving).
NameTypeRequiredDescription
version_idintegerYesVersion id (from list_versions)
list_version_itemsList the work items (epics, features, stories, tasks, defects) linked to a version, newest first, with title, number, status, due date and assignee.
NameTypeRequiredDescription
version_idintegerYesVersion id (from list_versions)
pageintegerNoPage number, from 1 (default 1)
limitintegerNoResults per page (default 25, max 100)
add_version_itemsLink work items to a version in one all-or-nothing call (up to 100).
NameTypeRequiredDescription
version_idintegerYesVersion id (from list_versions)
itemsarrayYesItems to link
remove_version_itemUnlink one work item from a version. item_id is the link id shown by list_version_items, not the task id.
NameTypeRequiredDescription
version_idintegerYesVersion id (from list_versions)
item_idintegerYesLink id from list_version_items
get_version_progressCompletion of a version: linked items done out of total, overall percent, and per type.
NameTypeRequiredDescription
version_idintegerYesVersion id (from list_versions)
get_release_roadmapRoadmap of a project, or of every project you can access when project_id is omitted: versions in planned start order, each with its releases.
NameTypeRequiredDescription
project_idstringNoProject numeric id or uniq_id; omit for every project you can access
statusstringNoComma-separated version statuses: Draft, Planned, Active, On Hold, Released or Archived
include_archivedbooleanNoInclude Archived versions (default false)
pageintegerNoPage number, from 1 (default 1)
limitintegerNoResults per page (default 25, max 100)
list_releasesList releases (shippable builds of a version, such as 4.2.1) for a version, a project, or every project you can access.
NameTypeRequiredDescription
version_idintegerNoOnly releases of this version
project_idstringNoProject numeric id or uniq_id; omit for all your projects
statusstringNoOnly this status: Draft, Planned, Testing, Ready, Approved, Released, Rolled Back or Cancelled
typestringNoOnly this type: Major, Minor, Patch, Hotfix, Beta or Release Candidate
searchstringNoMatches name or release number
sortstringNoname, status, type, planned_release_dt or created (default planned_release_dt)
directionstringNoasc or desc (default desc)
pageintegerNoPage number, from 1 (default 1)
limitintegerNoResults per page (default 25, max 100)
get_releaseGet 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.
NameTypeRequiredDescription
release_idintegerYesRelease id (from list_releases)
create_releaseCreate 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.
NameTypeRequiredDescription
version_idintegerYesVersion id the release belongs to
release_numberstringYesRelease number, e.g. 4.2.1
namestringYesRelease name
typestringYesRelease type: Major, Minor, Patch, Hotfix, Beta or Release Candidate
descriptionstringNoDescription
planned_release_dtstringNoPlanned release date, not in the past when creating (YYYY-MM-DD; empty string clears it)
owner_idstringNoOwner user id or uniq_id; must be an active member of the workspace; empty string clears it
update_releaseUpdate a release's name, description, type, planned date or owner.
NameTypeRequiredDescription
release_idintegerYesRelease id (from list_releases)
namestringNoRelease name
descriptionstringNoDescription
typestringNoRelease type: Major, Minor, Patch, Hotfix, Beta or Release Candidate
planned_release_dtstringNoPlanned release date, not in the past when creating (YYYY-MM-DD; empty string clears it)
owner_idstringNoOwner user id or uniq_id; must be an active member of the workspace; empty string clears it
transition_releaseMove a release to another status: Draft, Planned, Testing, Ready, Approved, Released, Rolled Back or Cancelled.
NameTypeRequiredDescription
release_idintegerYesRelease id (from list_releases)
statusstringYesTarget status: Draft, Planned, Testing, Ready, Approved, Released, Rolled Back or Cancelled
delete_releaseDelete a release (soft delete, as in the app).
NameTypeRequiredDescription
release_idintegerYesRelease id (from list_releases)
list_release_itemsList the work items included in a release, newest first, with title, status and assignee.
NameTypeRequiredDescription
release_idintegerYesRelease id (from list_releases)
pageintegerNoPage number, from 1 (default 1)
limitintegerNoResults per page (default 25, max 100)
add_release_itemsInclude version items in a release, all or nothing (up to 100).
NameTypeRequiredDescription
release_idintegerYesRelease id (from list_releases)
version_item_idsarrayYesLink ids from list_version_items
remove_release_itemRemove one item from a release. item_id is the link id from list_release_items.
NameTypeRequiredDescription
release_idintegerYesRelease id (from list_releases)
item_idintegerYesLink id from list_release_items
get_release_readinessWhether 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.
NameTypeRequiredDescription
release_idintegerYesRelease id (from list_releases)
list_my_pending_approvalsList 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).

This tool takes no arguments.

get_release_approval_chainThe 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.
NameTypeRequiredDescription
release_idintegerYesRelease id (from list_releases)
approve_release_stepApprove a release approval step assigned to you.
NameTypeRequiredDescription
step_idintegerYesApproval step id from list_my_pending_approvals
commentstringYesYour comment (required; basic HTML allowed)
reject_release_stepReject a release approval step assigned to you, with a required comment explaining why.
NameTypeRequiredDescription
step_idintegerYesApproval step id from list_my_pending_approvals
commentstringYesYour comment (required; basic HTML allowed)
cancel_release_approval_chainCancel the whole approval chain of a release (every live step).
NameTypeRequiredDescription
release_idintegerYesRelease id (from list_releases)
get_release_notesGet a release's notes (markdown), whether they were generated or written by hand (is_manual_override), and when.
NameTypeRequiredDescription
release_idintegerYesRelease id (from list_releases)
generate_release_notesGenerate a release's notes from its items: New Features (epics, features), Improvements (stories, tasks) and Fixed Issues (defects).
NameTypeRequiredDescription
release_idintegerYesRelease id (from list_releases)
confirmbooleanNoReplace hand-written notes (default false)
update_release_notesReplace a release's notes with your own markdown.
NameTypeRequiredDescription
release_idintegerYesRelease id (from list_releases)
contentstringYesRelease notes in markdown

Versions and releases: Release dependencies3#

Dependencies between releases.

list_release_dependenciesWhat a release waits on (blocked_by) and what waits on it (blocks).
NameTypeRequiredDescription
release_idintegerYesRelease id (from list_releases)
add_release_dependencyMake 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.
NameTypeRequiredDescription
release_idintegerYesThe release that waits (blocked release)
upstream_release_idintegerYesThe release it waits on
dependency_typestringNohard (default) or soft
reasonstringNoWhy it waits, shown with the dependency
remove_release_dependencyDelete a dependency, addressed through either of its releases (the waiting one or the upstream).
NameTypeRequiredDescription
release_idintegerYesEither release of the dependency
dependency_idintegerYesDependency id from list_release_dependencies

Versions and releases: Go-live checklist4#

The checklist a release must clear before going live.

list_release_checklistA release's go-live checklist in order: each item's text, whether it is required, and whether, by whom and when it was checked.
NameTypeRequiredDescription
release_idintegerYesRelease id (from list_releases)
add_release_checklist_itemAppend an item to a release's go-live checklist.
NameTypeRequiredDescription
release_idintegerYesRelease id (from list_releases)
labelstringYesItem text, up to 500 characters
is_requiredbooleanNoWhether it blocks Ready until checked (default false)
set_release_checklist_itemCheck or uncheck an item of a release's checklist.
NameTypeRequiredDescription
release_idintegerYesRelease id (from list_releases)
item_idintegerYesChecklist item id from list_release_checklist
checkedbooleanYestrue to check, false to uncheck
delete_release_checklist_itemDelete an item from a release's checklist.
NameTypeRequiredDescription
release_idintegerYesRelease id (from list_releases)
item_idintegerYesChecklist item id from list_release_checklist

Versions and releases: Blackout windows5#

Windows when releases may not go live, and overrides.

list_blackout_windowsList 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).
NameTypeRequiredDescription
include_inactivebooleanNoAlso list deactivated windows
searchstringNoMatches the window name
pageintegerNoPage number, from 1 (default 1)
limitintegerNoResults per page (default 25, max 100)
create_blackout_windowCreate 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.
NameTypeRequiredDescription
namestringYesWindow name, e.g. Year-end freeze
starts_atstringYesStart, YYYY-MM-DD or YYYY-MM-DD HH:MM
ends_atstringYesEnd, YYYY-MM-DD or YYYY-MM-DD HH:MM
enforcementstringYeshard or soft
recurrencestringNonone (default) or annually
descriptionstringNoOptional description
applies_to_release_typesarrayNoRelease types it applies to; empty for all
applies_to_project_idsarrayNoProject numeric ids or uniq_ids it applies to; empty for all
deactivate_blackout_windowDeactivate a blackout window so it no longer applies.
NameTypeRequiredDescription
window_idintegerYesWindow id from list_blackout_windows
check_release_blackoutCheck 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.
NameTypeRequiredDescription
release_idintegerYesRelease id (from list_releases)
datestringNoDate to check instead of the planned date, YYYY-MM-DD
override_release_blackoutRecord an override that lets a release ship inside a blackout window, with the reason (requires the VRM administration permission).
NameTypeRequiredDescription
release_idintegerYesRelease id (from list_releases)
window_idintegerYesWindow id from list_blackout_windows
reasonstringYesWhy the release may ship anyway

Versions and releases: Customer impact6#

Customer segments and the impact a release has on them.

list_impact_segmentsList the company's customer impact segments (e.g. enterprise, smb) by label.
NameTypeRequiredDescription
include_inactivebooleanNoAlso list deactivated segments
searchstringNoMatches label or key
pageintegerNoPage number, from 1 (default 1)
limitintegerNoResults per page (default 25, max 100)
create_impact_segmentCreate 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.
NameTypeRequiredDescription
keystringYesSegment key, e.g. enterprise
labelstringYesDisplay name, e.g. Enterprise
descriptionstringNoOptional description
deactivate_impact_segmentDeactivate a customer impact segment.
NameTypeRequiredDescription
segment_idintegerYesSegment id from list_impact_segments
assign_impact_segmentsMark a version item as affecting customer segments.
NameTypeRequiredDescription
version_item_idintegerYesLink id from list_version_items
segment_idsarrayYesSegment ids from list_impact_segments
unassign_impact_segmentRemove one customer segment from a version item.
NameTypeRequiredDescription
version_item_idintegerYesLink id from list_version_items
segment_idintegerYesSegment id
get_customer_impact_reportReleases 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.
NameTypeRequiredDescription
segment_idintegerYesSegment id from list_impact_segments
fromstringNoShipped on or after, YYYY-MM-DD
tostringNoShipped on or before, YYYY-MM-DD
pageintegerNoPage number, from 1 (default 1)
limitintegerNoResults per page (default 25, max 100)

Versions and releases: Release templates4#

Reusable release templates.

list_release_templatesList the company's release templates by name: release type, default release fields and go-live checklist.
NameTypeRequiredDescription
searchstringNoMatches the template name
pageintegerNoPage number, from 1 (default 1)
limitintegerNoResults per page (default 25, max 100)
get_release_templateOne release template with its type, default release fields (default_fields) and checklist items.
NameTypeRequiredDescription
template_idintegerYesTemplate id from list_release_templates
create_release_templateCreate 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.
NameTypeRequiredDescription
namestringYesTemplate name, unique in the company
typestringNoRelease type releases from it get by default
defaultsobjectNoDefault release fields: name, release_number, description, planned_release_dt, owner_id
checklist_itemsarrayNoChecklist items in order
create_release_from_templateCreate a Draft release under a version from a template.
NameTypeRequiredDescription
template_idintegerYesTemplate id from list_release_templates
version_idintegerYesVersion to create the release under
release_numberstringNoRelease number, e.g. 4.2.1
namestringNoRelease name
typestringNoMajor, Minor, Patch, Hotfix, Beta or Release Candidate
descriptionstringNoRelease description
planned_release_dtstringNoPlanned date, YYYY-MM-DD, not in the past
owner_idstringNoOwner user numeric id or uniq_id

Versions and releases: Analytics, calendar and dashboard7#

Release analytics, the calendar, roadmap, dashboard and activity.

get_release_analyticsRelease 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.
NameTypeRequiredDescription
project_idstringNoProject numeric id or uniq_id; omit for every project you can access
release_typestringNoMajor, Minor, Patch, Hotfix, Beta or Release Candidate
get_release_time_in_statusHow many hours a release spent in each status, from its status history in order; the last segment is its current status, counted until now.
NameTypeRequiredDescription
release_idintegerYesRelease id (from list_releases)
get_release_failure_trendPer 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.
NameTypeRequiredDescription
project_idstringNoProject numeric id or uniq_id; omit for every project you can access
periodstringNo3m, 6m, 12m (default) or 24m
get_version_burndownA 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.
NameTypeRequiredDescription
version_idintegerYesVersion id (from list_versions)
get_release_calendarReleases 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.
NameTypeRequiredDescription
fromstringNoStart date, YYYY-MM-DD
tostringNoEnd date, YYYY-MM-DD
project_idstringNoProject numeric id or uniq_id; omit for every project you can access
typestringNoOnly this type
statusstringNoOnly this status
get_release_dashboardThe 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.
NameTypeRequiredDescription
project_idstringNoProject numeric id or uniq_id; omit for every project you can access
typestringNoOnly this release type
list_version_release_activityThe 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.
NameTypeRequiredDescription
entity_typestringYesRelease or Version
entity_idintegerYesRelease or version id
pageintegerNoPage number, from 1 (default 1)
limitintegerNoResults per page (default 25, max 100)

Versions and releases: Workflow rules and lookups2#

Version workflow rules and which versions a work item belongs to.

get_version_release_workflowThe 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).
NameTypeRequiredDescription
entity_typestringYesVersion or Release
project_idstringNoProject numeric id or uniq_id, for its own rules; omit for the company rules
get_work_item_versionsWhich 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.
NameTypeRequiredDescription
entity_typestringYesEpic, Feature, Story, Task or Defect
entity_idintegerYesTask or defect numeric id

Scaled Agile (SAFe): Agile Release Trains13#

Release trains with their teams, roles and projects.

list_artsList 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.
NameTypeRequiredDescription
statusstringNoactive or archived
pageintegerNoPage number (default 1)
limitintegerNoItems per page, 1 to 100 (default 25)
get_artGet 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.
NameTypeRequiredDescription
art_idintegerYesART id (from list_arts)
get_art_healthHealth 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.
NameTypeRequiredDescription
art_idintegerYesART id
list_art_dependenciesList 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.
NameTypeRequiredDescription
art_idintegerYesART id
create_artCreate an Agile Release Train. code is upper-cased and must be unique in the workspace.
NameTypeRequiredDescription
namestringYesTrain name, up to 120 characters
codestringYesShort unique code, up to 20 characters, e.g. PAY
descriptionstringNoWhat the train delivers
program_idintegerNoProgram (project with purpose program) to group it under
pi_length_weeksintegerNoPI length in weeks (default 10)
iteration_length_weeksintegerNoIteration length in weeks (default 2)
has_ip_iterationbooleanNoWhether each PI ends with an IP iteration (default true)
update_artUpdate an Agile Release Train's name, code, description, program or cadence.
NameTypeRequiredDescription
art_idintegerYesART id
namestringNoNew name
codestringNoNew code
descriptionstringNoNew description
program_idintegerNoProgram to group it under, 0 for none
pi_length_weeksintegerNoPI length in weeks
iteration_length_weeksintegerNoIteration length in weeks
has_ip_iterationbooleanNoWhether PIs end with an IP iteration
archive_artArchive an Agile Release Train (action archive) or bring an archived one back (action restore).
NameTypeRequiredDescription
art_idintegerYesART id
actionstringYesarchive or restore
attach_art_teamAttach a team to an Agile Release Train from today. get_art lists the teams that can be attached (attachable_teams).
NameTypeRequiredDescription
art_idintegerYesART id
team_idintegerYesTeam id (from get_art attachable_teams)
detach_art_teamDetach a team from an Agile Release Train as of today.
NameTypeRequiredDescription
art_idintegerYesART id
team_idintegerYesTeam id
attach_art_projectLink a project to an Agile Release Train, so its epics, features and stories appear in the train's backlog.
NameTypeRequiredDescription
art_idintegerYesART id
project_idintegerYesProject id
detach_art_projectUnlink a project from an Agile Release Train.
NameTypeRequiredDescription
art_idintegerYesART id
project_idintegerYesProject id
assign_art_roleGive a workspace member a SAFe role on an Agile Release Train: rte (Release Train Engineer), product_manager, system_architect or business_owner.
NameTypeRequiredDescription
art_idintegerYesART id
user_idintegerYesMember's user id
rolestringYesrte, product_manager, system_architect or business_owner
revoke_art_roleRevoke a SAFe role assignment on an Agile Release Train as of today.
NameTypeRequiredDescription
art_idintegerYesART id
assignment_idintegerYesRole assignment id (from get_art roles)

Scaled Agile (SAFe): Program increments and the program board9#

Plan, lock and close program increments; iterations; the program board.

list_program_incrementsList program increments (PIs), latest start first, with their iterations.
NameTypeRequiredDescription
art_idintegerNoOnly PIs of this ART
statusstringNoplanning, executing or closed
pageintegerNoPage number (default 1)
limitintegerNoItems per page, 1 to 100 (default 25)
get_program_incrementGet one program increment: its ART, theme, business context, dates, status (planning, executing, closed), iterations, PI objectives and ROAM risks.
NameTypeRequiredDescription
pi_idintegerYesProgram increment id
create_program_incrementCreate a program increment (PI) on an ART, in Planning.
NameTypeRequiredDescription
art_idintegerYesART the PI belongs to
namestringYesPI name, up to 80 characters, e.g. PI 26.4
start_datestringYesFirst day, YYYY-MM-DD
end_datestringYesLast day, YYYY-MM-DD
themestringNoOptional PI theme
business_contextstringNoOptional business context
update_program_incrementUpdate a program increment's name, theme, business context or dates.
NameTypeRequiredDescription
pi_idintegerYesProgram increment id
namestringNoNew name
themestringNoNew theme
business_contextstringNoNew business context
start_datestringNoNew first day, YYYY-MM-DD
end_datestringNoNew last day, YYYY-MM-DD
transition_program_incrementMove a program increment along its lifecycle: lock (Planning to Executing, which freezes its plan) or close (Executing to Closed).
NameTypeRequiredDescription
pi_idintegerYesProgram increment id
actionstringYeslock or close
get_iterationGet 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).
NameTypeRequiredDescription
iteration_idintegerYesIteration id (from get_program_increment)
get_program_boardGet 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.
NameTypeRequiredDescription
pi_idintegerYesProgram increment id
place_on_program_boardPlace 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).
NameTypeRequiredDescription
pi_idintegerYesProgram increment id
item_idintegerYesWork item id
team_idintegerYesTeam id (from get_program_board teams)
iteration_idintegerYesIteration id of this PI
committed_load_pctintegerNoCapacity committed, 1 to 100 (default 100)
remove_from_program_boardRemove a placement from a program increment's board.
NameTypeRequiredDescription
pi_idintegerYesProgram increment id
entry_idintegerYesBoard entry id (from get_program_board)

Scaled Agile (SAFe): PI objectives, risks and confidence votes8#

PI objectives, ROAM risks and confidence votes.

list_pi_objectivesList a program increment's team PI objectives, committed first, with planned business value (1 to 10) and, once recorded, actual business value.
NameTypeRequiredDescription
pi_idintegerYesProgram increment id
create_pi_objectiveAdd 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).
NameTypeRequiredDescription
pi_idintegerYesProgram increment id
descriptionstringYesThe objective
team_idintegerNoTeam the objective belongs to
is_committedbooleanNoCommitted (true, default) or stretch (false)
planned_business_valueintegerNoPlanned business value 1 to 10 (default 5)
update_pi_objectiveUpdate 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.
NameTypeRequiredDescription
objective_idintegerYesObjective id
descriptionstringNoNew description
team_idintegerNoTeam, 0 for the whole ART
is_committedbooleanNoCommitted or stretch
planned_business_valueintegerNoPlanned business value 1 to 10
actual_business_valueintegerNoActual business value delivered 0 to 10
list_roam_risksList a program increment's ROAM risks, newest first, each Resolved, Owned, Accepted or Mitigated, with its owner.
NameTypeRequiredDescription
pi_idintegerYesProgram increment id
statusstringNoresolved, owned, accepted or mitigated
create_roam_riskRaise a risk on a program increment and ROAM it: resolved, owned (default), accepted or mitigated, optionally with an owner.
NameTypeRequiredDescription
pi_idintegerYesProgram increment id
descriptionstringYesThe risk
statusstringNoresolved, owned (default), accepted or mitigated
owner_idintegerNoMember who owns the risk
update_roam_riskUpdate a ROAM risk's description, owner or status (resolved, owned, accepted, mitigated).
NameTypeRequiredDescription
risk_idintegerYesRisk id
descriptionstringNoNew description
statusstringNoresolved, owned, accepted or mitigated
owner_idintegerNoOwner, 0 for none
cast_confidence_voteCast your fist-of-five confidence vote (1 to 5) on a program increment's plan, for a voting round (default 1).
NameTypeRequiredDescription
pi_idintegerYesProgram increment id
voteintegerYesConfidence 1 (none) to 5 (high)
roundintegerNoVoting round 1 to 10 (default 1)
team_idintegerNoTeam you vote for
get_confidence_vote_summaryConfidence vote results for a program increment, per round: number of votes and average overall and per team.
NameTypeRequiredDescription
pi_idintegerYesProgram increment id

Scaled Agile (SAFe): Backlog, dependencies and WSJF9#

Backlog planning, the portfolio kanban, dependencies and WSJF scoring.

list_safe_backlogList the SAFe backlog: epics, features and stories with their ART, PI, iteration, team, kanban state, rank and latest WSJF score.
NameTypeRequiredDescription
art_idintegerNoART
pi_idintegerNoProgram increment
team_idintegerNoTeam
levelstringNoepic, feature or story
project_idintegerNoProject
program_idintegerNoProgram
qstringNoSearch in titles
pageintegerNoPage number (default 1)
limitintegerNoItems per page, 1 to 100 (default 25)
get_safe_backlog_itemGet 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.
NameTypeRequiredDescription
item_idintegerYesWork item id of an epic, feature or story
update_safe_backlog_planningSet 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.
NameTypeRequiredDescription
item_idintegerYesWork item id
art_idintegerNoART
pi_idintegerNoProgram increment
iteration_idintegerNoIteration
team_idintegerNoTeam
rankintegerNoBacklog rank, lower first
story_subtypestringNouser or enabler
enabler_kindstringNoarchitectural, infrastructure, exploration or compliance
feature_estimateintegerNoFeature estimate, 0 or more
epic_sizestringNoEpic size label, up to 10 characters
transition_safe_backlog_itemMove 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).
NameTypeRequiredDescription
item_idintegerYesWork item id
state_idintegerYesTarget kanban state id
commentstringNoWhy, up to 500 characters
list_safe_kanban_statesList 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.
NameTypeRequiredDescription
levelstringNoepic, feature or story (default all three)
add_backlog_dependencyRecord a dependency between two backlog items: the first blocks (default), is related to, duplicates or is the parent of the second.
NameTypeRequiredDescription
from_item_idintegerYesItem the dependency starts from
to_item_idintegerYesItem it points to
dependency_typestringNoblocks (default), related, duplicates or parent_of
notestringNoOptional note, up to 500 characters
remove_backlog_dependencyRemove a backlog dependency by its id (from get_safe_backlog_item or list_art_dependencies).
NameTypeRequiredDescription
dependency_idintegerYesDependency id
record_wsjf_scoreScore an epic, feature or story for Weighted Shortest Job First.
NameTypeRequiredDescription
item_idintegerYesWork item id
business_valueintegerYesUser / business value
time_criticalityintegerYesTime criticality
risk_reductionintegerYesRisk reduction / opportunity enablement
job_sizeintegerYesJob size
get_wsjf_leaderboardRank an ART's epics, features or stories (default features) by their latest WSJF score, highest first, unscored last — the order to pull work in.
NameTypeRequiredDescription
art_idintegerYesART id
levelstringNoepic, feature (default) or story

Scaled Agile (SAFe): Inspect & Adapt and flow metrics7#

Inspect & Adapt sessions, improvement items and flow metrics.

list_inspect_adapt_sessionsList Inspect & Adapt sessions, most recent first, with their PI, facilitator, improvement item count and the predictability the web app last cached.
NameTypeRequiredDescription
pi_idintegerNoOnly the session of this PI
pageintegerNoPage number (default 1)
limitintegerNoItems per page, 1 to 100 (default 25)
get_inspect_adapt_sessionGet 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.
NameTypeRequiredDescription
session_idintegerYesSession id
create_inspect_adapt_sessionOpen the Inspect & Adapt session for a program increment, with the date it is held, optional system demo notes and a facilitator.
NameTypeRequiredDescription
pi_idintegerYesProgram increment id
held_onstringYesDate held, YYYY-MM-DD
system_demo_notesstringNoNotes from the system demo
facilitator_idintegerNoFacilitating member
add_improvement_itemAdd 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.
NameTypeRequiredDescription
session_idintegerYesSession id
problem_statementstringYesThe problem
root_causestringNoRoot cause
countermeasurestringNoCountermeasure
owner_idintegerNoOwning member
target_pi_idintegerNoPI the fix is targeted at
update_improvement_itemUpdate an improvement item's problem, root cause, countermeasure, owner, target PI or status (open, in_progress, done, dropped).
NameTypeRequiredDescription
session_idintegerYesSession id
improvement_idintegerYesImprovement item id
problem_statementstringNoNew problem statement
root_causestringNoRoot cause
countermeasurestringNoCountermeasure
owner_idintegerNoOwner, 0 for none
target_pi_idintegerNoTarget PI, 0 for none
statusstringNoopen, in_progress, done or dropped
get_flow_metricsGet an Agile Release Train's flow metrics: flow velocity, distribution, time, load and efficiency as stored period series, or one metric.
NameTypeRequiredDescription
art_idintegerYesART id
metricstringNoflow_velocity, flow_distribution, flow_time, flow_load or flow_efficiency (default all)
fromstringNoEarliest period start, YYYY-MM-DD
tostringNoLatest period end, YYYY-MM-DD
pi_idintegerNoRestrict distribution totals to this PI
recompute_flow_velocityRecompute 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.
NameTypeRequiredDescription
art_idintegerYesART id

Scaled Agile (SAFe): Dashboard, pickers and permissions4#

The SAFe dashboard, program and team pickers, and the caller's SAFe permissions.

get_safe_dashboardThe 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.
NameTypeRequiredDescription
art_idintegerNoNarrow the PI, flow, heatmap and dependency figures to this ART
program_idintegerNoNarrow work item figures to this Program's projects (see list_safe_programs)
list_safe_programsList 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.
NameTypeRequiredDescription
qstringNoSearch text matched against name or description
limitintegerNoMaximum rows (default 500, max 1000)
list_safe_teamsList the workspace's active teams (status active and not past their end date) with member counts.
NameTypeRequiredDescription
qstringNoSearch text matched against name or description
limitintegerNoMaximum rows (default 500, max 1000)
get_safe_permissionsShow 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.

This tool takes no arguments.

Resource management8#

Availability and capacity, utilization of logged time, the allocation report and skills.

get_resource_availabilityResource 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).
NameTypeRequiredDescription
start_datestringNoFirst day, YYYY-MM-DD (default: first day of the current month)
end_datestringNoLast day, YYYY-MM-DD (default: end of start_date's month); at most 92 days after start_date
project_idintegerNoOnly members of this project
user_idsarrayNoOnly these users (ids from list_users)
skill_idsarrayNoOnly people holding any of these skills (ids from list_resource_skills)
role_idintegerNoOnly members with this company role
business_unit_idintegerNoOnly members of this business unit
experiencenumberNoOnly people with a skill at exactly this many years of experience
include_dailybooleanNoAdd a per-day breakdown for each resource (default false)
pageintegerNoPage of resources, default 1
limitintegerNoResources per page, 1-100 (default 10)
get_resource_day_bookingsWhat 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).
NameTypeRequiredDescription
user_idintegerYesResource (user id)
datestringYesDay, YYYY-MM-DD
get_resource_summarySummary 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.
NameTypeRequiredDescription
user_idintegerYesResource (user id)
start_datestringNoFirst day, YYYY-MM-DD (default: first day of the current month)
end_datestringNoLast day, YYYY-MM-DD (default: end of start_date's month); at most 92 days after start_date
get_resource_utilizationResource 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).
NameTypeRequiredDescription
start_datestringNoFirst day, YYYY-MM-DD (default: first day of the current month)
end_datestringNoLast day, YYYY-MM-DD (default: end of start_date's month); at most 366 days after start_date
group_byarrayNoColumns to group by
project_idsarrayNoOnly these projects
user_idsarrayNoOnly time logged by these users
label_idsarrayNoOnly tasks with any of these labels
is_billablebooleanNoOnly billable (true) or non-billable (false) time
statusesarrayNoTask status tokens: 1 New, 2 In Progress, 3 Closed, 5 Resolved, c<id> for a custom status
searchstringNoMatch resource name, log description, and project name / task title when those are grouped
sort_bystringNohours, or a grouped column: resource, project, date, task_title
sort_dirstringNoasc or desc (default asc)
pageintegerNoPage, default 1
limitintegerNoRows per page, 1-100 (default 50)
get_team_utilizationTeam 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.
NameTypeRequiredDescription
periodstringNomonth (weekly buckets, default) or quarter (monthly buckets)
datestringNoAny day in the month or quarter, YYYY-MM-DD (default today)
basisstringNowork_hours (default) or booked
project_idsarrayNoOnly time (and bookings) on these projects
user_idsarrayNoOnly these users
role_idsarrayNoOnly members holding these company roles
get_allocation_reportThe 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.
NameTypeRequiredDescription
viewstringNoestimated (default) or spent
start_datestringNoFirst day, YYYY-MM-DD (default: first day of the current month)
end_datestringNoLast day, YYYY-MM-DD (default: end of start_date's month); at most 92 days after start_date
project_idsarrayNoOnly these projects
user_idsarrayNoOnly tasks assigned to (estimated) or time logged by (spent) these users
role_idintegerNoOnly people holding this company role
limitintegerNoTasks to return, 1-200 (default 50)
get_allocation_weekly_statusThe 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.
NameTypeRequiredDescription
start_datestringNoFirst day, YYYY-MM-DD (default: first day of the current month)
end_datestringNoLast day, YYYY-MM-DD (default: end of start_date's month); at most 92 days after start_date
project_idsarrayNoOnly these projects
user_idsarrayNoOnly tasks assigned to these users
role_idintegerNoOnly tasks assigned to people holding this company role
list_resource_skillsList the workspace's skills, alphabetically, each with the people holding it and their years of experience.
NameTypeRequiredDescription
searchstringNoPart of the skill name
user_idintegerNoOnly skills this person holds
project_idintegerNoOnly skills held by members of this project
pageintegerNoPage, default 1
limitintegerNoSkills per page, 1-100 (default 25)

Attendance7#

Clock status, clock in and out, attendance records, who is in today, the dashboard and reports.

get_attendance_statusYour 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).

This tool takes no arguments.

clock_inClock yourself in now (your own attendance only).
NameTypeRequiredDescription
work_location_idintegerNoWork location id (from get_attendance_status)
project_idintegerNoProject to clock against; you must be a member
notesstringNoOptional note
clock_outClock yourself out of your open session (even one started on an earlier day), with an optional note that replaces the session's note.
NameTypeRequiredDescription
notesstringNoOptional note
list_attendance_recordsTimesheet 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).
NameTypeRequiredDescription
user_idintegerNoUser id (default: you)
start_datestringNoYYYY-MM-DD (default 30 days ago)
end_datestringNoYYYY-MM-DD (default today)
pageintegerNoSessions page (default 1)
per_pageintegerNoSessions per page, max 100 (default 20)
get_team_attendanceWho 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.
NameTypeRequiredDescription
datestringNoYYYY-MM-DD (default today)
presencestringNoclocked_in, clocked_out, not_clocked_in or on_leave
searchstringNoFilter by employee name
pageintegerNoPage (default 1)
per_pageintegerNoEmployees per page, max 100 (default 50)
get_attendance_dashboardYour 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.

This tool takes no arguments.

get_attendance_reportAn 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).
NameTypeRequiredDescription
report_typestringYesattendance_summary or late_arrivals
start_datestringNoYYYY-MM-DD (default first of this month)
end_datestringNoYYYY-MM-DD (default today)
user_idintegerNoNarrow to one user in your scope
pageintegerNolate_arrivals page (default 1)
per_pageintegerNolate_arrivals page size (default 20, max 100)

Leave12#

Leave types, balances, holidays, requests, approvals and reports.

list_leave_typesThe active leave types you can apply for (id, name, code, paid, whether half days are allowed).

This tool takes no arguments.

get_leave_balancesLeave balances per leave type for a year (default this year): annual quota, carried forward, accrued, used, pending and available days.
NameTypeRequiredDescription
user_idintegerNoUser id (default: you)
yearintegerNoYear (default this year)
list_holidaysThe 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.
NameTypeRequiredDescription
yearintegerNoYear (default this year)
list_leave_requestsLeave 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).
NameTypeRequiredDescription
scopestringNomy, team or all
statusstringNopending, in_approval, approved, rejected or cancelled
leave_type_idintegerNoLeave type id
user_idintegerNoNarrow to one user within the scope
start_datestringNoRequests starting on or after YYYY-MM-DD
end_datestringNoRequests ending on or before YYYY-MM-DD
pageintegerNoPage (default 1)
per_pageintegerNoPer page, max 100 (default 20)
get_leave_requestOne 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).
NameTypeRequiredDescription
leave_request_idintegerYesLeave request id
preview_leave_daysHow 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.
NameTypeRequiredDescription
start_datestringYesYYYY-MM-DD
end_datestringYesYYYY-MM-DD
is_half_daybooleanNoHalf-day request (single date)
apply_leaveApply 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).
NameTypeRequiredDescription
leave_type_idintegerYesLeave type id
start_datestringYesYYYY-MM-DD
end_datestringYesYYYY-MM-DD
reasonstringYesReason for the leave
is_half_daybooleanNoHalf day (start and end must match)
half_day_periodstringNofirst_half or second_half
cancel_leave_requestCancel a leave request that is still pending or in approval; its days return to the available balance and its pending approvals are withdrawn.
NameTypeRequiredDescription
leave_request_idintegerYesLeave request id
get_leave_reportA 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).
NameTypeRequiredDescription
report_typestringYesleave_summary or leave_balance
start_datestringNoYYYY-MM-DD (default first of this month)
end_datestringNoYYYY-MM-DD (default today)
user_idintegerNoNarrow to one user in your scope
list_leave_approvalsLeave 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).

This tool takes no arguments.

approve_leave_requestApprove a leave request at your level of its approval chain, with a required comment.
NameTypeRequiredDescription
leave_request_idintegerYesLeave request id
commentstringYesApproval comment (required)
reject_leave_requestReject a leave request at your level of its approval chain, with a required comment.
NameTypeRequiredDescription
leave_request_idintegerYesLeave request id
commentstringYesRejection reason (required)

Risk management: Register7#

Create, read, update, move through the workflow and delete risks.

list_risksList 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.
NameTypeRequiredDescription
project_idintegerNoOnly risks of this project
statusstringNoWorkflow state key, e.g. identified, mitigation_in_progress, closed_resolved
ratingstringNoRating level: low, medium, high or critical
categorystringNoCategory, e.g. technical
risk_typestringNoThreat or Opportunity
owner_idintegerNoOnly risks owned by this member
min_scoreintegerNoOnly risks scoring at least this
open_onlybooleanNoLeave out closed risks
searchstringNoText to find in display id, title, description or tags
sortstringNocreated (default), modified, display_id, title, score, residual_score, rating, status, category, review_date, probability or impact
directionstringNoasc or desc (default)
pageintegerNoPage number (default 1)
limitintegerNoResults per page (default 25, max 100)
get_riskRead 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.
NameTypeRequiredDescription
risk_idintegerYesRisk id (the number in risk_id, not the RISK-0042 display id)
get_risk_settingsEverything needed to fill a risk in correctly.

This tool takes no arguments.

create_riskCreate a Risk Management risk (for SAFe program risks use create_roam_risk).
NameTypeRequiredDescription
titlestringYesShort name of the risk (max 255 characters)
descriptionstringNoWhat could happen and why
impact_descriptionstringNoWhat happens if the risk materialises
project_idintegerNoProject the risk belongs to (on create defaults to the first project)
categorystringNoCategory from get_risk_settings (e.g. technical, financial)
risk_typestringNoThreat or Opportunity
risk_sourcestringNoStakeholder, Team, Process, External, Audit or Other
owner_idintegerNoRisk owner, an active member (on create defaults to you)
secondary_owner_idintegerNoCo-owner, different from the owner; 0 clears
mitigation_owner_idintegerNoMember accountable for the mitigation; 0 clears
probabilityintegerNoLikelihood rating, 1 to the methodology scale (usually 5)
impactintegerNoImpact rating, 1 to the methodology scale
residual_probabilityintegerNoLikelihood after treatment
residual_impactintegerNoImpact after treatment
vulnerability_ratingintegerNoVulnerability rating (ISMS methodologies)
confidentiality_ratingintegerNoConfidentiality rating (asset-based methodologies)
integrity_ratingintegerNoIntegrity rating (asset-based methodologies)
availability_ratingintegerNoAvailability rating (asset-based methodologies)
residual_vulnerability_ratingintegerNoVulnerability rating after treatment
threat_idintegerNoThreat catalogue item (list_risk_catalogue type=threats); seeds probability when unset; 0 clears
vulnerability_idintegerNoVulnerability catalogue item; seeds vulnerability_rating when unset; 0 clears
soa_controlsstringNoISO/IEC 27001 Annex A controls, comma-separated (e.g. 5.15, 8.7)
existing_controlsstringNoControls already in place
residual_detailsstringNoResidual risk description (on create defaults to the title)
remarksstringNoFree-form remarks
response_strategystringNoavoid, mitigate, transfer, accept, exploit, share or enhance
mitigation_planstringNoPlanned mitigation actions
contingency_planstringNoFallback if the mitigation fails
mitigation_statusstringNoNot Started, In Progress, Completed or On Hold
mitigation_due_datestringNoMitigation due date, YYYY-MM-DD
budget_impactnumberNoFinancial impact in company currency (needs the View Financial Impact permission)
schedule_impactintegerNoSchedule delay in days
review_datestringNoNext review date, YYYY-MM-DD
target_resolution_datestringNoTarget resolution date, YYYY-MM-DD
date_identifiedstringNoDate identified, YYYY-MM-DD (defaults to today)
risk_proximitystringNoImminent, Near-term, Medium-term or Long-term
escalation_levelstringNoFree text, e.g. Team, Management, Executive (max 30)
tagsstringNoComma-separated tags
workflow_idintegerNoWorkflow from get_risk_settings; omit for the company default
update_riskUpdate a risk's fields; only the fields you pass change, and the score and rating are recomputed.
NameTypeRequiredDescription
risk_idintegerYesRisk id
titlestringNoShort name of the risk (max 255 characters)
descriptionstringNoWhat could happen and why
impact_descriptionstringNoWhat happens if the risk materialises
project_idintegerNoProject the risk belongs to (on create defaults to the first project)
categorystringNoCategory from get_risk_settings (e.g. technical, financial)
risk_typestringNoThreat or Opportunity
risk_sourcestringNoStakeholder, Team, Process, External, Audit or Other
owner_idintegerNoRisk owner, an active member (on create defaults to you)
secondary_owner_idintegerNoCo-owner, different from the owner; 0 clears
mitigation_owner_idintegerNoMember accountable for the mitigation; 0 clears
probabilityintegerNoLikelihood rating, 1 to the methodology scale (usually 5)
impactintegerNoImpact rating, 1 to the methodology scale
residual_probabilityintegerNoLikelihood after treatment
residual_impactintegerNoImpact after treatment
vulnerability_ratingintegerNoVulnerability rating (ISMS methodologies)
confidentiality_ratingintegerNoConfidentiality rating (asset-based methodologies)
integrity_ratingintegerNoIntegrity rating (asset-based methodologies)
availability_ratingintegerNoAvailability rating (asset-based methodologies)
residual_vulnerability_ratingintegerNoVulnerability rating after treatment
threat_idintegerNoThreat catalogue item (list_risk_catalogue type=threats); seeds probability when unset; 0 clears
vulnerability_idintegerNoVulnerability catalogue item; seeds vulnerability_rating when unset; 0 clears
soa_controlsstringNoISO/IEC 27001 Annex A controls, comma-separated (e.g. 5.15, 8.7)
existing_controlsstringNoControls already in place
residual_detailsstringNoResidual risk description (on create defaults to the title)
remarksstringNoFree-form remarks
response_strategystringNoavoid, mitigate, transfer, accept, exploit, share or enhance
mitigation_planstringNoPlanned mitigation actions
contingency_planstringNoFallback if the mitigation fails
mitigation_statusstringNoNot Started, In Progress, Completed or On Hold
mitigation_due_datestringNoMitigation due date, YYYY-MM-DD
budget_impactnumberNoFinancial impact in company currency (needs the View Financial Impact permission)
schedule_impactintegerNoSchedule delay in days
review_datestringNoNext review date, YYYY-MM-DD
target_resolution_datestringNoTarget resolution date, YYYY-MM-DD
date_identifiedstringNoDate identified, YYYY-MM-DD (defaults to today)
risk_proximitystringNoImminent, Near-term, Medium-term or Long-term
escalation_levelstringNoFree text, e.g. Team, Management, Executive (max 30)
tagsstringNoComma-separated tags
workflow_idintegerNoWorkflow from get_risk_settings; omit for the company default
transition_riskMove a risk to another status of its workflow (get_risk lists the allowed next statuses).
NameTypeRequiredDescription
risk_idintegerYesRisk id
statusstringYesTarget state key, e.g. identified, under_assessment, mitigation_in_progress, escalated, monitoring, closed_resolved
commentstringNoWhy; required for some steps
delete_riskDelete a risk from the register.
NameTypeRequiredDescription
risk_idintegerYesRisk id

Risk management: Comments4#

Comments on a risk.

list_risk_commentsList the comments on a risk, oldest first, with author and time.
NameTypeRequiredDescription
risk_idintegerYesRisk id
pageintegerNoPage number (default 1)
limitintegerNoResults per page (default 25, max 100)
add_risk_commentPost a comment on a risk.
NameTypeRequiredDescription
risk_idintegerYesRisk id
commentstringYesComment text
mention_user_idsarrayNoMembers to mention
update_risk_commentEdit a comment on a risk.
NameTypeRequiredDescription
risk_idintegerYesRisk id
comment_idintegerYesComment id
commentstringYesNew text
delete_risk_commentDelete a comment on a risk.
NameTypeRequiredDescription
risk_idintegerYesRisk id
comment_idintegerYesComment id

Links to work items and to other risks.

list_risk_linksList the work items (tasks) linked to a risk with their link type, and the related risks with their relationship (parent, dependent, duplicate, derived).
NameTypeRequiredDescription
risk_idintegerYesRisk id
list_task_risksList 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.
NameTypeRequiredDescription
task_idintegerYesWork item (task) id
link_risk_taskLink a work item (task) to a risk, e.g. a task the risk blocks or that mitigates it.
NameTypeRequiredDescription
risk_idintegerYesRisk id
task_idintegerYesWork item (task) id
link_typestringNoHow they relate, e.g. blocks (default), mitigates, relates_to
unlink_risk_taskRemove the link between a work item (task) and a risk; list_risk_links shows the current links.
NameTypeRequiredDescription
risk_idintegerYesRisk id
task_idintegerYesWork item (task) id
link_risksRelate a risk to another risk of the workspace: parent, dependent (default), duplicate or derived.
NameTypeRequiredDescription
risk_idintegerYesRisk id
related_risk_idintegerYesThe other risk
relationship_typestringNoparent, dependent (default), duplicate or derived
unlink_risksRemove the relationship (parent, dependent, duplicate or derived) from a risk to another risk; both risks stay as they are.
NameTypeRequiredDescription
risk_idintegerYesRisk id
related_risk_idintegerYesThe other risk

Risk management: Watchers and approvals5#

Watchers and the approval steps of a risk.

add_risk_watcherAdd a member as a watcher of a risk; they are notified of status changes and comments.
NameTypeRequiredDescription
risk_idintegerYesRisk id
user_idintegerYesMember to add
remove_risk_watcherStop a member watching a risk, so they no longer get its status-change and comment notifications.
NameTypeRequiredDescription
risk_idintegerYesRisk id
user_idintegerYesWatcher to remove
list_risk_approvalsList risk approval steps.
NameTypeRequiredDescription
risk_idintegerNoOnly this risk
statusstringNopending (default without risk_id), approved or rejected
approve_risk_stepApprove one approval step of a risk, addressed by its step_index from list_risk_approvals.
NameTypeRequiredDescription
risk_idintegerYesRisk id
step_indexintegerNo0-based position of the step (default 0)
reject_risk_stepReject one approval step of a risk, addressed by its step_index from list_risk_approvals, with the reason.
NameTypeRequiredDescription
risk_idintegerYesRisk id
step_indexintegerNo0-based position of the step (default 0)
commentstringYesReason for rejecting

Risk management: Dashboard, heat map and reports5#

The risk dashboard, heat map, reports, ISMS catalogues, settings and audit trail.

get_risk_dashboardThe 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.

This tool takes no arguments.

get_risk_heatmapThe 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.
NameTypeRequiredDescription
project_idintegerNoOnly risks of this project
categorystringNoOnly this category
get_risk_reportRun 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).
NameTypeRequiredDescription
typestringYesregister, summary, overdue, trend, escalated, dependencies, treatment, residual or soa_coverage
list_risk_catalogueList 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.
NameTypeRequiredDescription
typestringYesthreats, vulnerabilities or controls
include_inactivebooleanNoAlso list inactive catalogue items
list_risk_activityA 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.
NameTypeRequiredDescription
risk_idintegerYesRisk id
pageintegerNoPage number (default 1)
limitintegerNoResults per page (default 25, max 100)

Checklists: Config and catalog reads4#

Checklists - config and catalog reads.

get_checklist_configRead 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.
NameTypeRequiredDescription
work_item_typestringNoOptional filter for the required-groups matrix. One of:
list_checklist_groupsList the company catalogue checklist groups (system and custom).
NameTypeRequiredDescription
active_onlybooleanNoWhen true, only active groups are returned
list_checklist_templatesList the company checklist templates with their items.

This tool takes no arguments.

get_work_item_checklistRead a work item's checklist: its groups with nested items and the overall/per-group completion status.
NameTypeRequiredDescription
work_item_typestringYesOne of:
work_item_idintegerYesNumeric id of the work item

Checklists: Catalog management6#

Checklists - catalog management.

create_checklist_groupCreate a custom company-catalogue checklist group.
NameTypeRequiredDescription
namestringYesThe group name (unique per company)
colorstringNoOptional hex colour, e.g. #3366ff
is_activebooleanNoWhether the group is active (default true)
update_checklist_groupUpdate a catalogue checklist group.
NameTypeRequiredDescription
group_idintegerYesThe catalogue group id
namestringNoNew name (custom groups only)
colorstringNoNew hex colour, e.g. #3366ff
is_activebooleanNoWhether the group is active
delete_checklist_groupDelete a custom catalogue checklist group (and its templates).
NameTypeRequiredDescription
group_idintegerYesThe catalogue group id
create_checklist_templateCreate a checklist template that owns one catalogue group and a list of item labels.
NameTypeRequiredDescription
checklist_group_idintegerYesThe catalogue group this template owns
namestringYesThe template name
auto_attachbooleanNoAuto-apply to new work items of the enabled types (default false)
is_activebooleanNoWhether the template is active (default true)
itemsarrayNoOrdered checklist item labels
update_checklist_templateUpdate a checklist template.
NameTypeRequiredDescription
template_idintegerYesThe template id
namestringNoNew template name
checklist_group_idintegerNoMove the template to a different catalogue group
auto_attachbooleanNoWhether to auto-apply on create
is_activebooleanNoWhether the template is active
itemsarrayNoReplacement ordered item labels (omit to leave items unchanged)
delete_checklist_templateDelete a checklist template and its items.
NameTypeRequiredDescription
template_idintegerYesThe template id

Checklists: Per work item10#

Checklists - per work item.

add_checklist_itemAdd a checklist item to a group on a work item.
NameTypeRequiredDescription
work_item_typestringYesOne of:
work_item_idintegerYesNumeric id of the work item
work_item_group_idintegerYesThe work-item group instance to add the item to
labelstringYesThe checklist item text
update_checklist_itemUpdate a checklist item's label (text only).
NameTypeRequiredDescription
item_idintegerYesThe checklist item id
labelstringYesThe new item text
delete_checklist_itemDelete a checklist item from a work item.
NameTypeRequiredDescription
item_idintegerYesThe checklist item id
complete_checklist_itemMark a checklist item complete or incomplete.
NameTypeRequiredDescription
item_idintegerYesThe checklist item id
is_completedbooleanNoSet true to complete, false to uncomplete; omit to toggle
add_checklist_groupAttach an existing catalogue checklist group (by its catalogue group id) to a work item.
NameTypeRequiredDescription
work_item_typestringYesOne of:
work_item_idintegerYesNumeric id of the work item
source_group_idintegerYesThe catalogue group id to attach
create_custom_checklist_groupCreate a one-off custom checklist group directly on a work item (not from the catalogue).
NameTypeRequiredDescription
work_item_typestringYesOne of:
work_item_idintegerYesNumeric id of the work item
namestringYesThe custom group name
rename_checklist_groupRename a checklist group on a work item (this work item only — never the shared catalogue).
NameTypeRequiredDescription
work_item_group_idintegerYesThe work-item group instance id
namestringYesThe new group name
delete_work_item_checklist_groupRemove a checklist group (and its items) from a work item.
NameTypeRequiredDescription
work_item_group_idintegerYesThe work-item group instance id
reorder_checklist_groupsSet the display order of a work item's checklist groups.
NameTypeRequiredDescription
work_item_typestringYesOne of:
work_item_idintegerYesNumeric id of the work item
group_idsarrayYesWork-item group instance ids in the desired order
add_checklist_group_from_templateCopy a checklist template (its group and all items) onto a work item as an independent group.
NameTypeRequiredDescription
work_item_typestringYesOne of:
work_item_idintegerYesNumeric id of the work item
template_idintegerYesThe checklist template id to copy

Resources and prompts

Alongside tools, the server exposes read-only resources that a client can pull in as context, and prompts that package a common request.

Resources

NameURIWhat it returns
projectsorangescrum://projectsAll projects in the authenticated workspace, with status and progress. Returned as Markdown.
my-tasksorangescrum://my-tasksOpen tasks assigned to the authenticated user across all projects. Returned as Markdown.
contextorangescrum://contextCompany-wide standing context that applies to every project in the workspace. Returned as Markdown.

Prompts

NameWhat it does
daily_standupDraft a daily standup message from the tasks you closed yesterday and the ones open today.
overdue_reportSummarize your overdue tasks by project and suggest what to prioritize or escalate.

Availability

The MCP server is available in the Cloud edition. Self-hosted support is planned but not shipped, so if you run Orangescrum on your own servers today, use the Partner API, which is available in both Cloud and Self-Hosted.

API and MCP access sit on the Premium plan. Compare plans, or talk to us if you want to work through what you are building first.