MCP REST API JSON

MCP · STREAMABLE HTTP · OAUTH 2.1

Connect an assistant

Claude, Cursor, VS Code and other MCP clients can read and change your work in Backlog.pm. A client acts as the person who connected it, in every space they can see, with exactly their role’s permissions.

SERVER URL /mcp
Tools
–
Resources
–
Prompts
–
Sign-in
OAuth

Quick start

Add the server, sign in, and ask away.

  1. 01

    Add the server to your client

    Use mcp.backlog.pm/mcp, the address for every workspace: signing in picks yours. Your workspace’s own {workspace}.backlog.pm/mcp works too and skips that choice. MCP has to be on for the workspace (the Owner turns it on in Account settings → Feature toggles).

  2. 02

    Sign in and approve

    The client opens your browser: sign in, pick the workspace and approve. No token to copy. A client that can’t sign in can use a token from Account settings → MCP server instead.

  3. 03

    Start with the context tools

    describe_workspace gives the valid types, statuses, labels and people; whats_new and my_work say what changed and what needs you.

Good to know

Permissions

A client is offered only the tools its person’s role can use, and every call is checked like the same action in the app. Tokens, AI keys and workspace deletion stay out of reach.

Safe retries

Every tool that changes something takes an idempotency_key: a retry with the same key answers with the first result instead of doing it twice. Keys last a day.

Catching up

whats_new remembers where you left off; list_changes follows a cursor and can wait up to 30 seconds for the next change.

Checking first

update_issues and revert_changes take dry_run, which runs every check and saves nothing. Every change lands in the item’s history “via MCP”.

Tools

What each tool does, what it takes, and what the connected person needs for it to be offered.

Loading the reference…