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.

PyPI Python 3.13+ License: MIT

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
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.2.0.tar.gz (325.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.2.0-py3-none-any.whl (74.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: mcp_server_polarion-1.2.0.tar.gz
  • Upload date:
  • Size: 325.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.2.0.tar.gz
Algorithm Hash digest
SHA256 7cb313a5cc50291db802a109d4791e32b24b4e3eb72b0baf79ae4f7e24a47bd1
MD5 bb8d48bcab1f39beedda4eec389b9467
BLAKE2b-256 25a3b806c0c6a780a481f24f6493941a156a96452e4c77744889386ebfaf43fd

See more details on using hashes here.

Provenance

The following attestation bundles were made for mcp_server_polarion-1.2.0.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.2.0-py3-none-any.whl.

File metadata

File hashes

Hashes for mcp_server_polarion-1.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 9a910ba00930e035c2191c252f52c8a5aaf405ceeb0f6ffa11418cfa886555f6
MD5 6e677fd3e17e78a4242b996df6f02a72
BLAKE2b-256 42c7052570d233907cb08c03b5317e1c8e92f1d9ec155aa9769b1f2ac875a54f

See more details on using hashes here.

Provenance

The following attestation bundles were made for mcp_server_polarion-1.2.0-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