What is the Orangescrum MCP server?

It is a Model Context Protocol server that lets an AI client such as Claude read and update your Orangescrum workspace directly. It exposes 72 tools covering projects, tasks, sprints, time logs, test management, defects, and checklists, so the assistant can answer questions about real project data and create or update work for you.

How do I connect Claude to Orangescrum?

Add the Orangescrum MCP endpoint to your client configuration and sign in when the browser window opens. In Claude Code the command is: claude mcp add --transport http orangescrum followed by your Orangescrum MCP URL. In Claude Desktop, add the server to claude_desktop_config.json and restart the app.

Can the AI see data the user is not allowed to see?

No. The connection is authenticated as a specific Orangescrum user through OAuth, and every tool runs with that user's permissions. An assistant can never read or change anything the person who connected it could not read or change themselves.

Is the MCP server available in the self-hosted edition?

The MCP server is available in the Cloud edition today. Self-hosted support is planned. The Partner REST API is available in both Cloud and Self-Hosted if you need to integrate now.

MCP server

Connect Claude, or any Model Context Protocol client, straight to your Orangescrum workspace. The assistant gets 72 tools and can answer questions about your real projects and create work for you, with your permissions and nothing more. There is no integration to build.

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.
Drive test cases, scenarios, steps, and defects.
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.

// 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://<your-orangescrum-host>/mcp/partner"
      ]
    }
  }
}

Replace the host with your Orangescrum host. 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.

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

72 tools in 9 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 every project the connected account can see, with optional status filter and paging.

Name	Type	Required	Description
`page`	integer	No	Page number for pagination.
`limit`	integer	No	Number of items per page.
`status`	string	No	Filter by project status: active, inactive, or completed.

get_projectGet the full detail of one project.

Name	Type	Required	Description
`project_id`	string	Yes	Project numeric id or uniq_id. A task returns its project as project_uniq_id, which resolves here.

create_projectCreate a project with a name, description, dates, and status.

Name	Type	Required	Description
`name`	string	Yes	Project name.
`description`	string	No	Project description.
`start_date`	string	No	Start date in YYYY-MM-DD format.
`end_date`	string	No	End date in YYYY-MM-DD format.
`status`	string	No	Project status: Started, Hold, Stack, or Completed.

update_projectUpdate a project. Only the fields you send are changed.

Name	Type	Required	Description
`project_id`	integer	Yes	Numeric id of the project to update.
`name`	string	No	New project name.
`description`	string	No	New project description.
`start_date`	string	No	Start date in YYYY-MM-DD format.
`end_date`	string	No	End date in YYYY-MM-DD format.
`status`	string	No	Project status: Started, Hold, Stack, or Completed.

search_projectsSearch projects by free text with optional status, owner, and date filters.

Name	Type	Required	Description
`q`	string	No	Free-text query matched against project name, short name, or description.
`status`	string	No	Filter by project status: active, inactive, or completed.
`status_group_id`	integer	No	Filter by status group id.
`owner_id`	integer	No	Filter by project owner user id.
`start_date`	string	No	Only projects starting on or after this date (YYYY-MM-DD).
`end_date`	string	No	Only projects ending on or before this date (YYYY-MM-DD).
`page`	integer	No	Page number. Default 1.
`limit`	integer	No	Items per page. Default 15, max 100.

Tasks and work items10#

Work with tasks and the Scrum backlog hierarchy of Epic, Feature, Story, task, and subtask.

list_tasksList tasks, filtered by project, user, or status.

Name	Type	Required	Description
`project_id`	integer	No	Filter tasks by project id.
`user_id`	integer	No	Filter tasks by user id.
`status`	string	No	Filter by status: pending, in_progress, completed, or cancelled.
`page`	integer	No	Page number. Omit to return all matching tasks, up to 200.
`limit`	integer	No	Items per page, 1 to 100. Omit to return all matching tasks, up to 200.

list_tasks_v2List tasks on the v2 contract, with strict project filtering, deterministic paging, and normalized ids.

Name	Type	Required	Description
`project_id`	integer	No	Strict numeric project filter.
`mine`	boolean	No	When true, return only tasks assigned to the authenticated user.
`status`	string	No	Status filter as CSV or array values: open, in_progress, pending, closed, completed, cancelled.
`page`	integer	No	Page number. Default 1.
`limit`	integer	No	Items per page. Default 20, max 100.

get_taskGet the full detail of one task.

Name	Type	Required	Description
`task_id`	string	Yes	Task numeric id or uniq_id. Both are returned by list_tasks, search_tasks, and get_task.

create_taskCreate a task in a project.

Name	Type	Required	Description
`project_id`	string	Yes	Project numeric id or uniq_id.
`title`	string	Yes	Task title.
`description`	string	No	Task description.
`assigned_to`	integer	No	User id to assign the task to.
`priority`	string	No	Priority: low, medium, high, or urgent.
`due_date`	string	No	Due date in YYYY-MM-DD format.

update_taskUpdate a task. Only the fields you send are changed.

Name	Type	Required	Description
`task_id`	string	Yes	Task numeric id or uniq_id.
`title`	string	No	New task title.
`description`	string	No	New task description.
`status`	string	No	Status: pending, in_progress, completed, or cancelled.
`priority`	string	No	Priority: low, medium, high, or urgent.
`assigned_to`	integer	No	User id to assign the task to.
`due_date`	string	No	Due date in YYYY-MM-DD format.

search_tasksSearch tasks by free text with optional project, status, priority, and assignee filters.

Name	Type	Required	Description
`q`	string	No	Free-text query matched against task title and description.
`project_id`	integer	No	Filter tasks by project id.
`status`	string	No	Filter by status: pending, in_progress, completed, or cancelled.
`priority`	string	No	Filter by priority: low, medium, high, or urgent.
`assigned_to`	integer	No	Filter by assignee user id.
`page`	integer	No	Page number. Omit to return all matching tasks, up to 200.
`limit`	integer	No	Items per page, 1 to 100. Omit to return all matching tasks, up to 200.

create_epicCreate an Epic, the top level of the Scrum backlog, in a project. Orangescrum v4 projects only.

Name	Type	Required	Description
`project_id`	string	Yes	Project numeric id or uniq_id.
`title`	string	Yes	Epic title.
`description`	string	No	Epic description.
`assigned_to`	integer	No	User id to assign the epic to.
`priority`	string	No	Priority: low, medium, or high.
`due_date`	string	No	Due date in YYYY-MM-DD format.
`story_point`	integer	No	Story points.

create_featureCreate a Feature under an existing Epic. It inherits the project of that Epic. Orangescrum v4 projects only.

Name	Type	Required	Description
`epic_id`	integer	Yes	Numeric id of the parent Epic.
`title`	string	Yes	Feature title.
`description`	string	No	Feature description.
`assigned_to`	integer	No	User id to assign the feature to.
`priority`	string	No	Priority: low, medium, or high.
`due_date`	string	No	Due date in YYYY-MM-DD format.
`story_point`	integer	No	Story points.

create_storyCreate a Story, optionally under a Feature or an Epic. Orangescrum v4 projects only.

Name	Type	Required	Description
`project_id`	string	Yes	Project numeric id or uniq_id.
`title`	string	Yes	Story title.
`feature_id`	integer	No	Parent Feature id. The Story inherits the Epic of that Feature.
`epic_id`	integer	No	Parent Epic id. Ignored when feature_id is given.
`description`	string	No	Story description.
`assigned_to`	integer	No	User id to assign the story to.
`priority`	string	No	Priority: low, medium, or high.
`due_date`	string	No	Due date in YYYY-MM-DD format.
`story_point`	integer	No	Story points.

create_subtaskCreate a child item under a Story or a Task. The child inherits the project, Epic, and Feature of its parent. Orangescrum v4 projects only.

Name	Type	Required	Description
`parent_task_id`	string	Yes	Parent Story or Task numeric id or uniq_id.
`title`	string	Yes	Title of the child item.
`type_id`	integer	No	Type id. Defaults to the type of the parent.
`description`	string	No	Description.
`assigned_to`	integer	No	User id to assign the item to.
`priority`	string	No	Priority: low, medium, or high.
`due_date`	string	No	Due date in YYYY-MM-DD format.
`story_point`	integer	No	Story points.

Sprints7#

Plan, run, and close sprints, and move tasks in and out of them. Orangescrum v4 projects only.

list_sprintsList the active sprints of a project, with the running sprint first.

Name	Type	Required	Description
`project_id`	string	Yes	Project numeric id or uniq_id.

get_sprintGet one sprint by its numeric id or uniq_id.

Name	Type	Required	Description
`sprint_id`	string	Yes	Sprint numeric id or uniq_id.

create_sprintCreate a sprint in a project. It starts in the not-yet-started state.

Name	Type	Required	Description
`project_id`	string	Yes	Project numeric id or uniq_id.
`title`	string	Yes	Sprint title, unique within the project.
`description`	string	No	Sprint goal or description.
`start_date`	string	No	Planned start date in YYYY-MM-DD format.
`end_date`	string	No	Planned end date in YYYY-MM-DD format.

update_sprintUpdate a sprint title, goal, or planned dates. Only the fields you send are changed.

Name	Type	Required	Description
`sprint_id`	string	Yes	Sprint numeric id or uniq_id.
`title`	string	No	New sprint title, unique within the project.
`description`	string	No	New sprint goal or description.
`start_date`	string	No	Planned start date in YYYY-MM-DD format. An empty string clears it.
`end_date`	string	No	Planned end date in YYYY-MM-DD format. An empty string clears it.

start_sprintStart a sprint. Unless parallel sprints are enabled, only one sprint per project can run at a time.

Name	Type	Required	Description
`sprint_id`	string	Yes	Sprint numeric id or uniq_id.
`start_date`	string	No	Start date in YYYY-MM-DD format. Must be sent with end_date.
`end_date`	string	No	End date in YYYY-MM-DD format. Must be sent with start_date.
`title`	string	No	Rename the sprint as it starts.
`description`	string	No	Set the sprint goal as it starts.

complete_sprintClose a sprint, snapshot the done tasks for velocity, and move the incomplete ones out.

Name	Type	Required	Description
`sprint_id`	string	Yes	Sprint numeric id or uniq_id.
`incomplete_destination`	string	No	Where incomplete tasks go: "backlog" (default) or "next_sprint:<id>" for another active sprint in the same project.

assign_task_to_sprintMove a top-level task into a sprint, or back to the backlog. Its descendants move with it.

Name	Type	Required	Description
`task_id`	string	Yes	Task numeric id or uniq_id. Must be a top-level task, not a subtask.
`sprint_id`	string	No	Target sprint numeric id or uniq_id. Omit or leave empty to move the task to the backlog.
`position`	integer	No	Zero-based order of the task within the sprint.

Time logs3#

Read and record time logged against tasks.

list_timelogsList the time logs of the connected user, with optional project, task, and date filters.

Name	Type	Required	Description
`project_id`	integer	No	Filter time logs by project id.
`task_id`	integer	No	Filter time logs by task id.
`from`	string	No	Start date (YYYY-MM-DD), inclusive.
`to`	string	No	End date (YYYY-MM-DD), inclusive.
`page`	integer	No	Page number. Default 1.
`limit`	integer	No	Items per page. Default 20, max 100.

create_timelogLog time against a task. Send total_hours, or send explicit start and end times.

Name	Type	Required	Description
`project_id`	integer	Yes	Project id the time is logged against.
`task_id`	integer	No	Task id the time is logged against.
`task_date`	string	Yes	Date of the work in YYYY-MM-DD format.
`description`	string	Yes	Description of the work done.
`total_hours`	number	No	Total hours spent, as a decimal. For example 2.5 for two and a half hours.
`start_time`	string	No	Start time in HH:MM:SS format. Overrides the times derived from total_hours.
`end_time`	string	No	End time in HH:MM:SS format. Overrides the times derived from total_hours.
`is_billable`	boolean	No	Whether the time is billable. Default false.

update_timelogUpdate a time log entry. Only the fields you send are changed.

Name	Type	Required	Description
`timelog_id`	integer	Yes	Numeric id of the time log to update.
`task_date`	string	No	Date of the work in YYYY-MM-DD format.
`description`	string	No	Description of the work done.
`total_hours`	number	No	Total hours spent, as a decimal.
`start_time`	string	No	Start time in HH:MM:SS format.
`end_time`	string	No	End time in HH:MM:SS format.
`is_billable`	boolean	No	Whether the time is billable.

Users3#

Look up the connected user and the other people in the company.

get_current_userReturn the authenticated user profile, including timezone, roles, and default workspace.

This tool takes no arguments.

list_usersList the users in the company, with an optional name or email search.

Name	Type	Required	Description
`search`	string	No	Case-insensitive match on user name or email.
`page`	integer	No	Page number. Default 1.
`limit`	integer	No	Items per page. Default 20, max 100.

get_userGet the detail of one user.

Name	Type	Required	Description
`user_id`	string	Yes	User numeric id or uniq_id. Both are returned by list_users and get_user.

Test management15#

Manage test scenarios, test cases, and the steps inside a case. Orangescrum v4 workspaces only.

list_test_scenariosList test scenarios, with optional project, type, and status filters.

Name	Type	Required	Description
`project_id`	string	No	Filter by project numeric id or uniq_id.
`type`	string	No	Filter by scenario type.
`status`	string	No	Filter by status.
`q`	string	No	Search term matched against name and description.
`include_archived`	boolean	No	Include archived scenarios.
`page`	integer	No	Page number. Default 1.
`limit`	integer	No	Items per page. Default 20, max 100.

get_test_scenarioGet one test scenario by its uniq_id.

Name	Type	Required	Description
`scenario_id`	string	Yes	Test scenario uniq_id.

create_test_scenarioCreate a test scenario in a project.

Name	Type	Required	Description
`project_id`	string	Yes	Project numeric id or uniq_id.
`name`	string	Yes	Scenario name.
`description`	string	No	Scenario description.
`type`	string	No	Scenario type.
`coverage_percentage`	number	No	Coverage percentage, 0 to 100.
`status`	string	No	Status. Default Active.

update_test_scenarioUpdate a test scenario. Only the fields you send are changed.

Name	Type	Required	Description
`scenario_id`	string	Yes	Test scenario uniq_id.
`name`	string	No	Scenario name.
`description`	string	No	Scenario description.
`type`	string	No	Scenario type.
`coverage_percentage`	number	No	Coverage percentage, 0 to 100.
`status`	string	No	Status.

delete_test_scenarioArchive a test scenario, or delete it permanently.

Name	Type	Required	Description
`scenario_id`	string	Yes	Test scenario uniq_id.
`hard_delete`	boolean	No	Permanently delete instead of archive.

list_test_casesList test cases, with optional project, scenario, status, and priority filters. Archived cases are excluded by default.

Name	Type	Required	Description
`project_id`	string	No	Filter by project numeric id or uniq_id.
`scenario_id`	string	No	Filter by parent test scenario uniq_id.
`status`	string	No	Filter by status.
`priority`	string	No	Filter by priority.
`q`	string	No	Search term matched against name and description.
`include_archived`	boolean	No	Include archived test cases.
`page`	integer	No	Page number. Default 1.
`limit`	integer	No	Items per page. Default 20, max 100.

get_test_caseGet one test case by its uniq_id.

Name	Type	Required	Description
`test_case_id`	string	Yes	Test case uniq_id.

create_test_caseCreate a test case in a project, optionally attached to a test scenario.

Name	Type	Required	Description
`project_id`	string	Yes	Project numeric id or uniq_id.
`name`	string	Yes	Test case name.
`description`	string	No	Test case description.
`type`	string	No	Test case type.
`priority`	string	No	Priority, for example High, Medium, or Low.
`severity`	string	No	Severity.
`behaviour`	string	No	Behaviour, for example Positive or Negative.
`status`	string	No	Status. Default Active.
`scenario_id`	string	No	Parent test scenario uniq_id.
`pre_condition`	string	No	Pre-condition.
`post_condition`	string	No	Post-condition.
`expected_result`	string	No	Expected result.

update_test_caseUpdate a test case. Only the fields you send are changed.

Name	Type	Required	Description
`test_case_id`	string	Yes	Test case uniq_id.
`name`	string	No	Test case name.
`description`	string	No	Test case description.
`type`	string	No	Test case type.
`priority`	string	No	Priority.
`severity`	string	No	Severity.
`behaviour`	string	No	Behaviour.
`status`	string	No	Status.
`scenario_id`	string	No	Parent test scenario uniq_id.
`expected_result`	string	No	Expected result.

delete_test_caseArchive a test case, or delete it permanently along with its step links.

Name	Type	Required	Description
`test_case_id`	string	Yes	Test case uniq_id.
`hard_delete`	boolean	No	Permanently delete instead of archive.

list_test_stepsList the steps of a test case, in their ordered sequence.

Name	Type	Required	Description
`test_case_id`	string	Yes	Parent test case uniq_id.
`include_archived`	boolean	No	Include archived or unlinked steps.
`page`	integer	No	Page number. Default 1.
`limit`	integer	No	Items per page. Default 100, max 100.

create_test_stepAdd a step to a test case. The step is appended to the end of the current order.

Name	Type	Required	Description
`test_case_id`	string	Yes	Parent test case uniq_id.
`name`	string	No	Step name or short label.
`description`	string	No	Step description. Required when no name is given.
`expected_result`	string	No	Expected result.
`outcome`	string	No	Actual outcome.
`status`	string	No	Status. Default Active.

update_test_stepUpdate one step of a test case. Only the fields you send are changed.

Name	Type	Required	Description
`test_case_id`	string	Yes	Parent test case uniq_id.
`step_id`	string	Yes	Test step uniq_id.
`name`	string	No	Step name.
`description`	string	No	Step description.
`expected_result`	string	No	Expected result.
`outcome`	string	No	Actual outcome.
`status`	string	No	Status.

reorder_test_stepsReorder the steps of a test case. Steps you leave out keep their relative order after the listed ones.

Name	Type	Required	Description
`test_case_id`	string	Yes	Parent test case uniq_id.
`step_ids`	array	Yes	Ordered list of test step uniq_ids.

delete_test_stepRemove a step from a test case. The step is archived by default, or deleted permanently.

Name	Type	Required	Description
`test_case_id`	string	Yes	Parent test case uniq_id.
`step_id`	string	Yes	Test step uniq_id.
`hard_delete`	boolean	No	Permanently delete instead of archive.

Defects6#

File defects, track their status, and link them to test cases, test steps, and tasks.

list_defectsList defects, with optional project, status, priority, severity, test case, and text filters.

Name	Type	Required	Description
`project_id`	string	No	Filter by project numeric id or uniq_id.
`status`	string	No	Filter by status.
`priority`	string	No	Filter by priority.
`severity`	string	No	Filter by severity.
`test_case_id`	string	No	Filter by linked test case uniq_id.
`q`	string	No	Search term matched against title, description, and defect number.
`page`	integer	No	Page number. Default 1.
`limit`	integer	No	Items per page. Default 20, max 100.

get_defectGet one defect by its uniq_id.

Name	Type	Required	Description
`defect_id`	string	Yes	Defect uniq_id.

create_defectFile a defect in a project. The defect number is generated for you and the status defaults to Open.

Name	Type	Required	Description
`project_id`	string	Yes	Project numeric id or uniq_id.
`title`	string	Yes	Defect title.
`description`	string	No	Defect description.
`type`	string	No	Defect type.
`priority`	string	No	Priority.
`severity`	string	No	Severity.
`status`	string	No	Status. Default Open.
`test_case_id`	string	No	Linked test case uniq_id.
`test_step_id`	string	No	Linked test step uniq_id.
`task_id`	string	No	Linked task uniq_id.

update_defectUpdate the descriptive fields of a defect. Use set_defect_status and link_defect for status and links.

Name	Type	Required	Description
`defect_id`	string	Yes	Defect uniq_id.
`title`	string	No	Defect title.
`description`	string	No	Defect description.
`type`	string	No	Defect type.
`priority`	string	No	Priority.
`severity`	string	No	Severity.

link_defectLink a defect to a test case, a test step, or a task. Give at least one target.

Name	Type	Required	Description
`defect_id`	string	Yes	Defect uniq_id.
`test_case_id`	string	No	Test case uniq_id to link.
`test_step_id`	string	No	Test step uniq_id to link.
`task_id`	string	No	Task uniq_id to link.

set_defect_statusChange the status of a defect. Resolved and closed states also record who resolved it and when.

Name	Type	Required	Description
`defect_id`	string	Yes	Defect uniq_id.
`status`	string	Yes	New status, for example Open, In Progress, Resolved, or Closed.

Checklists20#

Manage the company checklist catalogue and templates, and the checklists attached to individual work items.

get_checklist_configRead the company checklist configuration: whether it is on, the policy flags, and the required-groups matrix.

Name	Type	Required	Description
`work_item_type`	string	No	Filter the required-groups matrix. One of: epic, feature, story, task, defect, test_scenario, test_case, test_defect, project, program.

list_checklist_groupsList the company catalogue checklist groups, both system and custom.

Name	Type	Required	Description
`active_only`	boolean	No	When true, return only active groups.

create_checklist_groupCreate a custom checklist group in the company catalogue. Names must be unique per company.

Name	Type	Required	Description
`name`	string	Yes	Group name, unique per company.
`color`	string	No	Hex colour, for example #3366ff.
`is_active`	boolean	No	Whether the group is active. Default true.

update_checklist_groupUpdate a catalogue checklist group. System groups cannot be renamed, only recoloured or deactivated.

Name	Type	Required	Description
`group_id`	integer	Yes	Catalogue group id.
`name`	string	No	New name. Custom groups only.
`color`	string	No	New hex colour, for example #3366ff.
`is_active`	boolean	No	Whether the group is active.

delete_checklist_groupDelete a custom catalogue checklist group and its templates. System groups cannot be deleted.

Name	Type	Required	Description
`group_id`	integer	Yes	Catalogue group id.

list_checklist_templatesList the company checklist templates with their items.

This tool takes no arguments.

create_checklist_templateCreate a checklist template that owns one catalogue group and a list of item labels.

Name	Type	Required	Description
`checklist_group_id`	integer	Yes	Catalogue group this template owns.
`name`	string	Yes	Template name.
`auto_attach`	boolean	No	Auto-apply to new work items of the enabled types. Default false.
`is_active`	boolean	No	Whether the template is active. Default true.
`items`	array	No	Ordered checklist item labels.

update_checklist_templateUpdate a checklist template. Sending items replaces the whole item list.

Name	Type	Required	Description
`template_id`	integer	Yes	Template id.
`name`	string	No	New template name.
`checklist_group_id`	integer	No	Move the template to a different catalogue group.
`auto_attach`	boolean	No	Whether to auto-apply on create.
`is_active`	boolean	No	Whether the template is active.
`items`	array	No	Replacement ordered item labels. Omit to leave items unchanged.

delete_checklist_templateDelete a checklist template and its items.

Name	Type	Required	Description
`template_id`	integer	Yes	Template id.

get_work_item_checklistRead the checklist of a work item: its groups, the nested items, and the completion status.

Name	Type	Required	Description
`work_item_type`	string	Yes	One of: epic, feature, story, task, defect, test_scenario, test_case, test_defect, project, program.
`work_item_id`	integer	Yes	Numeric id of the work item.

add_checklist_itemAdd an item to a checklist group on a work item. Returns the refreshed checklist.

Name	Type	Required	Description
`work_item_type`	string	Yes	One of: epic, feature, story, task, defect, test_scenario, test_case, test_defect, project, program.
`work_item_id`	integer	Yes	Numeric id of the work item.
`work_item_group_id`	integer	Yes	Work-item group instance to add the item to. Read it from get_work_item_checklist.
`label`	string	Yes	Checklist item text.

update_checklist_itemChange the text of a checklist item. Returns the refreshed checklist.

Name	Type	Required	Description
`item_id`	integer	Yes	Checklist item id.
`label`	string	Yes	New item text.

complete_checklist_itemMark a checklist item complete or incomplete, and stamp the acting user as the completer.

Name	Type	Required	Description
`item_id`	integer	Yes	Checklist item id.
`is_completed`	boolean	No	True to complete, false to uncomplete. Omit to toggle.

delete_checklist_itemDelete a checklist item from a work item. Returns the refreshed checklist.

Name	Type	Required	Description
`item_id`	integer	Yes	Checklist item id.

add_checklist_groupAttach an existing catalogue checklist group to a work item. Duplicate attaches are rejected.

Name	Type	Required	Description
`work_item_type`	string	Yes	One of: epic, feature, story, task, defect, test_scenario, test_case, test_defect, project, program.
`work_item_id`	integer	Yes	Numeric id of the work item.
`source_group_id`	integer	Yes	Catalogue group id to attach.

add_checklist_group_from_templateCopy a checklist template, group and items, onto a work item as an independent group.

Name	Type	Required	Description
`work_item_type`	string	Yes	One of: epic, feature, story, task, defect, test_scenario, test_case, test_defect, project, program.
`work_item_id`	integer	Yes	Numeric id of the work item.
`template_id`	integer	Yes	Checklist template id to copy.

create_custom_checklist_groupCreate a one-off checklist group directly on a work item. Allowed only when the company enables custom groups.

Name	Type	Required	Description
`work_item_type`	string	Yes	One of: epic, feature, story, task, defect, test_scenario, test_case, test_defect, project, program.
`work_item_id`	integer	Yes	Numeric id of the work item.
`name`	string	Yes	Custom group name.

rename_checklist_groupRename a checklist group on one work item. The shared catalogue is never touched.

Name	Type	Required	Description
`work_item_group_id`	integer	Yes	Work-item group instance id.
`name`	string	Yes	New group name.

reorder_checklist_groupsSet the display order of the checklist groups on a work item.

Name	Type	Required	Description
`work_item_type`	string	Yes	One of: epic, feature, story, task, defect, test_scenario, test_case, test_defect, project, program.
`work_item_id`	integer	Yes	Numeric id of the work item.
`group_ids`	array	Yes	Work-item group instance ids in the desired order.

delete_work_item_checklist_groupRemove a checklist group and its items from one work item. The catalogue group is left alone.

Name	Type	Required	Description
`work_item_group_id`	integer	Yes	Work-item group instance id.

Search and context3#

Search the workspace documents and read or save the standing context an assistant should remember.

search_documentsSearch the documents uploaded to the workspace by meaning and return the most relevant excerpts with their source. Orangescrum v4 workspaces only.

Name	Type	Required	Description
`query`	string	Yes	What to look for, in natural language.
`project_id`	integer	No	Project id to scope the search to one project.
`limit`	integer	No	Maximum excerpts to return, 1 to 20. Default 5.

get_project_contextRead the standing context saved for this workspace: background, conventions, and instructions. Orangescrum v4 projects only.

Name	Type	Required	Description
`project_id`	string	No	Project numeric id or uniq_id. Omit to get company-wide entries only.

add_project_contextSave a standing context entry so it is recalled in later conversations. This is a write action and asks the user to confirm. Orangescrum v4 projects only.

Name	Type	Required	Description
`title`	string	Yes	Short label for the entry.
`body`	string	Yes	The fact, convention, or instruction to remember.
`project_id`	string	No	Project numeric id or uniq_id to scope the entry. Omit for a company-wide entry.

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

Name	URI	What it returns
`projects`	orangescrum://projects	All projects in the authenticated workspace, with status and progress. Returned as Markdown.
`my-tasks`	orangescrum://my-tasks	Open tasks assigned to the authenticated user across all projects. Returned as Markdown.
`context`	orangescrum://context	Company-wide standing context that applies to every project in the workspace. Returned as Markdown.

Prompts

Name	What it does
`daily_standup`	Draft a daily standup message from the tasks you closed yesterday and the ones open today.
`overdue_report`	Summarize 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.