Skip to main content

MCP server for Polarion ALM — read and write documents and work items

Project description

mcp-server-polarion

A Model Context Protocol (MCP) server for Polarion ALM. Lets AI assistants read documents, work items, and traceability links — and create, update, and reorganize work items — directly from your Polarion instance.

CI Publish PyPI Python 3.13+ License: MIT

mcp-server-polarion demo

Features

  • 24 tools covering read and write across documents, work items, traceability links, and comments.
  • Read — render documents as Markdown, search with Lucene or SQL, walk incoming/outgoing links, resolve enum options.
  • Write — create and update work items and documents, manage links, reorganize document structure, post comments.
  • Safe writes — every write tool supports dry_run, and pre-write guards validate fields, enum values, and link targets before hitting Polarion.
  • Built for LLMs — strict async, fully typed, pagination on every list tool, docstrings written as the assistant's manual.

Quickstart

Requires uv (see Prerequisites). Fastest path — Claude Code:

claude mcp add mcp-server-polarion \
  -e POLARION_URL=https://polarion.example.com \
  -e POLARION_TOKEN=your-personal-access-token \
  -- uvx mcp-server-polarion

Other clients (VS Code, Claude Desktop, Cursor) — see Setup.

Prerequisites

Polarion 2506 or higher is required. Earlier versions lack REST API endpoints this server depends on.

This server is distributed as a Python package and requires uv to run.

Install uv (if not already installed):

# macOS / Linux
curl -LsSf https://astral.sh/uv/install.sh | sh

# Windows
powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"

Or via pip:

pip install uv

No other installation is needed — uvx mcp-server-polarion downloads and runs the server automatically.


Setup

Environment Variables

Variable Description Example
POLARION_URL Base URL of your Polarion instance https://polarion.example.com
POLARION_TOKEN Personal Access Token for authentication your-personal-access-token
VS Code (GitHub Copilot)

Add to .vscode/mcp.json:

{
  "servers": {
    "mcp-server-polarion": {
      "type": "stdio",
      "command": "uvx",
      "args": ["mcp-server-polarion"],
      "env": {
        "POLARION_URL": "https://polarion.example.com",
        "POLARION_TOKEN": "your-personal-access-token"
      }
    }
  }
}
Claude Desktop

Add to claude_desktop_config.json:

{
  "mcpServers": {
    "mcp-server-polarion": {
      "command": "uvx",
      "args": ["mcp-server-polarion"],
      "env": {
        "POLARION_URL": "https://polarion.example.com",
        "POLARION_TOKEN": "your-personal-access-token"
      }
    }
  }
}
Cursor

Add to Cursor MCP settings:

{
  "mcpServers": {
    "mcp-server-polarion": {
      "command": "uvx",
      "args": ["mcp-server-polarion"],
      "env": {
        "POLARION_URL": "https://polarion.example.com",
        "POLARION_TOKEN": "your-personal-access-token"
      }
    }
  }
}
Claude Code

Register via the claude mcp add command:

claude mcp add mcp-server-polarion \
  -e POLARION_URL=https://polarion.example.com \
  -e POLARION_TOKEN=your-personal-access-token \
  -- uvx mcp-server-polarion

Tools

Read

Tool Description
list_projects List accessible projects
list_documents List documents in a project
list_work_items Search work items with Lucene or SQL queries
get_sql_query_recipes Fetch copy-paste SQL recipes for advanced queries
get_document Get document metadata, optionally with the raw body HTML
read_document Render a document end-to-end as Markdown
read_document_parts List a document's structural parts with embedded work item metadata
get_work_item Get work item details with the body as raw HTML
read_work_item Get work item details with the body as Markdown
list_work_item_links List a work item's outgoing or incoming links
list_document_comments List a document's comments with thread relationships
list_document_enum_options Resolve valid enum ids for a document field
list_work_item_enum_options Resolve valid enum ids for a work item field

All list tools support pagination via page_size (1–100) and page_number parameters.

Write

Tool Description
create_work_items Create one or more work items in a single request
update_work_item Update an existing work item
create_document Create a new document
update_document Update document metadata, body, or workflow status
create_work_item_links Create one or more outgoing links from a source work item
update_work_item_link Update suspect / revision on one outgoing link
delete_work_item_links Delete one or more outgoing links from a source work item
move_work_item_to_document Attach a work item to a document at a chosen position
move_work_item_from_document Detach a work item from its document
create_document_comments Add one or more comments or replies to a document
update_document_comment Resolve or re-open a document comment

Example Prompts

Discovery & search

"List the projects I can access, then show the documents in project MCPT with their types."

"List the documents in space 'Specifications' of project MCPT."

"Find every approved requirement in project MCPT whose title starts with 'Auth' and show me their owning document."

"Search project MCPT for work items where the custom field 'verification_method' is 'Test' — grab the SQL recipes first if you need a join."

"Find all work items in the SRS module of project MCPT that were changed in the last sprint."

Reading & summarizing

"Read the SRS document of project MCPT and summarize each open requirement."

"Show me the structural outline of the SRS document — headings and the work items under each."

"Read work item MCPT-042 as Markdown and explain what it asks for."

"Show the outgoing and incoming links for MCPT-042 and flag any child task that is still open."

"Which requirements in the SRS document have no 'verifies' back link from a test case?"

"List the open comment threads on the SRS document and who started each."

Creating & editing

"Create a task in project MCPT titled 'Refactor authentication module' and link it to MCPT-042 as 'relates_to'."

"Create three test-case work items in project MCPT from this checklist and link each one to MCPT-042 as 'verifies'."

"Add a new requirement under section 3.2 of the SRS document with the body I just drafted."

"Update the description of MCPT-042 with the revised text I'll paste, keeping the existing formatting."

"Add a comment on the SRS document asking the owner to clarify section 4, then reply to thread T-12 marking it resolved."

Workflow & reorganization

"List the valid status values for a defect in project MCPT, then move MCPT-077 to 'in_review'."

"Bump MCPT-042's priority to 90, set severity to 'major', and approve the workflow."

"Change MCPT-201 from a task to a requirement and re-apply its previous status."

"Move MCPT-201 into the SRS document right after MCPT-150."

"Detach MCPT-077 from its document so I can rework it as a standalone task."

"Mark the 'blocks' link from MCPT-042 to MCPT-099 as suspect, then delete the stale 'relates_to' link to MCPT-010."

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mcp_server_polarion-1.3.1.tar.gz (133.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

mcp_server_polarion-1.3.1-py3-none-any.whl (70.7 kB view details)

Uploaded Python 3

File details

Details for the file mcp_server_polarion-1.3.1.tar.gz.

File metadata

  • Download URL: mcp_server_polarion-1.3.1.tar.gz
  • Upload date:
  • Size: 133.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for mcp_server_polarion-1.3.1.tar.gz
Algorithm Hash digest
SHA256 44c996e81a273494d6eb2a882dd92c4ea03f1e5fdbc8a41ab7254c5a8ca89c6c
MD5 908a6e76690cfd52a652501e11529b3d
BLAKE2b-256 9bc24d4d12cf4b5101d52ea86a2266d78e08ff6801420b5eaa9db2e8a12d4ce8

See more details on using hashes here.

Provenance

The following attestation bundles were made for mcp_server_polarion-1.3.1.tar.gz:

Publisher: publish.yml on devemberx/mcp-server-polarion

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file mcp_server_polarion-1.3.1-py3-none-any.whl.

File metadata

File hashes

Hashes for mcp_server_polarion-1.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 03fdaf157412f05dabb27a98d332740ae43fd7f21d91c4fcc2095f8279971ab0
MD5 29ca0b83466bae405958e86657a57778
BLAKE2b-256 df84e03f1641c47bbdbc86fb47ea75790fad39a1c6fd390f0c78518ae2e3429b

See more details on using hashes here.

Provenance

The following attestation bundles were made for mcp_server_polarion-1.3.1-py3-none-any.whl:

Publisher: publish.yml on devemberx/mcp-server-polarion

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page