Interact with Microsoft 365 and Office services through the Microsoft Graph API.
Polarion is installed from its publisher's own source and answers where it runs, so this marketplace is not in the path of a single call. There is no address here to send one to, and a panel that pretended otherwise would be showing you an answer we made up. Install it and call it from your own client — the Installation tab has the entry for each one.
What it does
Polarion ALM MCP server for requirements, LiveDocs, work items, traceability and test management.
Quickstart
# 1 — add it to Claude Code
claude mcp add --scope user --env 'API_BASE_URL=${API_BASE_URL}' --env 'BEARER_TOKEN=${BEARER_TOKEN}' --transport stdio phillipboesger-polarion-mcp '--' npx -y polarion-mcp
# 2 — ask your agent for something these tools do
# getGlobalFieldsMetadata, getAllDocuments, branchDocuments and 63 more
It needs API_BASE_URL, BEARER_TOKEN: this reads them from your environment, so export them first.
Polarion costs nothing on mcprush: there is no plan to choose here, no cap to set and nothing mcprush can bill you for.
Collected from a public index. Nobody has claimed this account, so nothing here was written by its author — claim it if it is yours.
Where are you running it?
Every route below installs the same thing and ends at the same approval screen. This one runs on your machine: your client starts Polarion as a process under your own user, with your files and your network, so the tool surface below is what it can do to your computer rather than to a server somewhere else. Its scan result is on the Security tab — read the surface before you approve it.
This is a public server: you run it yourself and this marketplace is not in the path. You need Node.js — the current LTS (24) is the safe choice; npx comes with it. Claude Code registers it in one command; --scope user makes it available in every project. Claude Code reads API_BASE_URL (Base URL for the Polarion REST API, e.g. https://your-polarion-server.com/polarion/rest/v1), BEARER_TOKEN (Personal Access Token (PAT) for authenticating with the Polarion REST API) from your environment each time it starts the server, so the value stays out of its config: export them in your shell profile (macOS, Linux), or run setx API_BASE_URL …, setx BEARER_TOKEN … and open a new terminal (Windows). The '--' is in quotes so that PowerShell passes it on.
claude mcp add --scope user --env 'API_BASE_URL=${API_BASE_URL}' --env 'BEARER_TOKEN=${BEARER_TOKEN}' --transport stdio phillipboesger-polarion-mcp '--' npx -y polarion-mcpReconnect, or start a new session, and the tools appear in the model’s tool list.
It reaches a system of yours, so it needs your own credential rather than the publisher’s: API_BASE_URL — Base URL for the Polarion REST API, e.g. https://your-polarion-server.com/polarion/rest/v1; BEARER_TOKEN — Personal Access Token (PAT) for authenticating with the Polarion REST API. You set them in your own client’s config, on your machine — this marketplace never holds it.
One config entry your client uses to start the process locally. A local server runs with your file system and your network, which is why it is priced without metering.
66 tools, with what each one reads, writes and reaches shown before you agree — the same list on every route above. Read the tool surface.
Tool surface
What the model actually sees. Descriptions are diffed on every release — see version history.
Read from its source code. A server that builds its tool list when it starts can list more tools than this.
Returns fields for the resource type and its target type in the Global context. Scope: spans every project (no project filter). To act on a single project, use getProjectFieldsMetadata instead.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| resourceType | string | yes | The Resource Type. |
| targetType | string | no | The configured subtype for this enumeration or custom field (e.g. requirement for a Work Item type). Use ~ (without quotes) when the configuration applies to every subtype. |
| response_format | string | no | Response detail level. concise removes redundant HTML and JSON:API metadata and may use a small default fieldset on large lists; detailed preserves the complete response. Defaults to detailed. |
Returns a list of Documents from all Projects. Scope: spans every project (no project filter). To act on a single project, use getDocuments instead. Examples: {"query":"title:Plan","page[size]":20}. Selection: Use getAllDocuments to search Documents across projects; use getDocuments when listing…
| Parameter | Type | Required | Notes |
|---|---|---|---|
| page[size] | number | no | Maximum number of items to return in this page (e.g. 100). Use together with page[number] to paginate through a large result set. |
| page[number] | number | no | 1-based page number to fetch when the result set is paginated (e.g. 2 for the second page). Combine with page[size]; omit to fetch the first page. |
| fields | object | no | Sparse fieldset selector: an object keyed by resource type (e.g. workitems) whose value is a comma-separated list of attribute names to return (e.g. id,title,status), reducing payload size. Omit t |
| include | string | no | Comma-separated list of related resource types to embed in the response (e.g. author,attachments) so they don't require a separate follow-up call. Omit to return only the primary resource. |
| query | string | no | Polarion Lucene-style query string to filter results: field:value clauses combined with AND/OR, phrases in quotes. Exact supported field names depend on the resource type being queried. |
| sort | string | no | Comma-separated list of fields to sort by, in priority order; prefix a field with - for descending order (e.g. -updated,title). |
| revision | string | no | A specific repository revision (e.g. 1234) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision. |
| response_format | string | no | Response detail level. concise removes redundant HTML and JSON:API metadata and may use a small default fieldset on large lists; detailed preserves the complete response. Defaults to detailed. |
| max_items | integer | no | Collect up to this many results across pages (maximum 1000). Omit to fetch only the requested page, as before. |
Creates branches for multiple source LiveDocs and returns an asynchronous jobs resource. Each documentConfigurations entry supplies a source and may specify its own target; omitted targets stay with the source location. Requires source read and target write permissions; poll getJob for…
| Parameter | Type | Required | Notes |
|---|---|---|---|
| requestBody | object | yes | Branching parameters. |
| dry_run | boolean | no | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually |
Returns a list of Pages from all Projects and Pages on the Repository level. Scope: spans every project (no project filter). To act on a single project, use getPages instead.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| page[size] | number | no | Maximum number of items to return in this page (e.g. 100). Use together with page[number] to paginate through a large result set. |
| page[number] | number | no | 1-based page number to fetch when the result set is paginated (e.g. 2 for the second page). Combine with page[size]; omit to fetch the first page. |
| fields | object | no | Sparse fieldset selector: an object keyed by resource type (e.g. workitems) whose value is a comma-separated list of attribute names to return (e.g. id,title,status), reducing payload size. Omit t |
| include | string | no | Comma-separated list of related resource types to embed in the response (e.g. author,attachments) so they don't require a separate follow-up call. Omit to return only the primary resource. |
| query | string | no | Polarion Lucene-style query string to filter results: field:value clauses combined with AND/OR, phrases in quotes. Exact supported field names depend on the resource type being queried. |
| sort | string | no | Comma-separated list of fields to sort by, in priority order; prefix a field with - for descending order (e.g. -updated,title). |
| revision | string | no | A specific repository revision (e.g. 1234) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision. |
| response_format | string | no | Response detail level. concise removes redundant HTML and JSON:API metadata and may use a small default fieldset on large lists; detailed preserves the complete response. Defaults to detailed. |
| max_items | integer | no | Collect up to this many results across pages (maximum 1000). Omit to fetch only the requested page, as before. |
Returns a list of Work Items from all Projects. Scope: spans every project (no project filter). To act on a single project, use getWorkItems instead. Examples: {"query":"type:requirement","fields":{"workitems":"id,title"},"page[size]":25}. Selection: Use getAllWorkItems when the search must span…
| Parameter | Type | Required | Notes |
|---|---|---|---|
| page[size] | number | no | Maximum number of items to return in this page (e.g. 100). Use together with page[number] to paginate through a large result set. |
| page[number] | number | no | 1-based page number to fetch when the result set is paginated (e.g. 2 for the second page). Combine with page[size]; omit to fetch the first page. |
| fields | object | no | Sparse fieldset selector: an object keyed by resource type (e.g. workitems) whose value is a comma-separated list of attribute names to return (e.g. id,title,status), reducing payload size. Omit t |
| include | string | no | Comma-separated list of related resource types to embed in the response (e.g. author,attachments) so they don't require a separate follow-up call. Omit to return only the primary resource. |
| query | string | no | Polarion Lucene-style query string to filter results: field:value clauses combined with AND/OR, phrases in quotes. Exact supported field names depend on the resource type being queried. |
| sort | string | no | Comma-separated list of fields to sort by, in priority order; prefix a field with - for descending order (e.g. -updated,title). |
| revision | string | no | A specific repository revision (e.g. 1234) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision. |
| response_format | string | no | Response detail level. concise removes redundant HTML and JSON:API metadata and may use a small default fieldset on large lists; detailed preserves the complete response. Defaults to detailed. |
| max_items | integer | no | Collect up to this many results across pages (maximum 1000). Omit to fetch only the requested page, as before. |
Deletes a list of Work Items from the Global context. Scope: spans every project (no project filter). To act on a single project, use deleteWorkItems instead. Effect: irreversible — data removed or overwritten by this call cannot be recovered through the API. Tip: set dry_run: true first to…
| Parameter | Type | Required | Notes |
|---|---|---|---|
| requestBody | object | yes | The Work Item(s) body. |
| dry_run | boolean | no | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually |
Updates a list of Work Items in the Global context. Scope: spans every project (no project filter). To act on a single project, use patchWorkItems instead. Tip: set dry_run: true first to validate the arguments and preview the exact request without sending it to Polarion. The executor returns…
| Parameter | Type | Required | Notes |
|---|---|---|---|
| workflowAction | string | no | The Workflow Action. |
| requestBody | object | yes | The Work Item(s) body. |
| dry_run | boolean | no | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually |
Creates a list of Custom Fields in the Global context. Scope: spans every project (no project filter). To act on a single project, use postProjectCustomFields instead. Effect: creates a new resource. Repeating this call may create additional resources; it is not guaranteed idempotent. Tip: set…
| Parameter | Type | Required | Notes |
|---|---|---|---|
| requestBody | object | yes | Custom Fields Body |
| dry_run | boolean | no | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually |
Returns the defined Custom Fields for the resource type and target type in the Global context. Scope: spans every project (no project filter). To act on a single project, use getProjectCustomFields instead.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| resourceType | string | yes | The Resource Type. |
| targetType | string | yes | The configured subtype for this enumeration or custom field (e.g. requirement for a Work Item type). Use ~ (without quotes) when the configuration applies to every subtype. |
| fields | object | no | Sparse fieldset selector: an object keyed by resource type (e.g. workitems) whose value is a comma-separated list of attribute names to return (e.g. id,title,status), reducing payload size. Omit t |
| include | string | no | Comma-separated list of related resource types to embed in the response (e.g. author,attachments) so they don't require a separate follow-up call. Omit to return only the primary resource. |
| response_format | string | no | Response detail level. concise removes redundant HTML and JSON:API metadata and may use a small default fieldset on large lists; detailed preserves the complete response. Defaults to detailed. |
Deletes the specified Custom Field configuration from the Global context. Scope: spans every project (no project filter). To act on a single project, use deleteProjectCustomFields instead. Effect: irreversible — data removed or overwritten by this call cannot be recovered through the API. Tip:…
| Parameter | Type | Required | Notes |
|---|---|---|---|
| resourceType | string | yes | The Resource Type. |
| targetType | string | yes | The configured subtype for this enumeration or custom field (e.g. requirement for a Work Item type). Use ~ (without quotes) when the configuration applies to every subtype. |
| dry_run | boolean | no | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually |
Replaces the entire list of global Custom Fields for one resource type and target type: fields missing from requestBody are deleted, not merged. Read the current list with getGlobalCustomFields first and send every field you want to keep. Effect: irreversible — data removed or overwritten by…
| Parameter | Type | Required | Notes |
|---|---|---|---|
| resourceType | string | yes | The Resource Type. |
| targetType | string | yes | The configured subtype for this enumeration or custom field (e.g. requirement for a Work Item type). Use ~ (without quotes) when the configuration applies to every subtype. |
| requestBody | object | yes | Custom Fields Body |
| dry_run | boolean | no | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually |
Returns a list of Enumerations from the Global context. Scope: spans every project (no project filter). To act on a single project, use getProjectEnumerations instead. Cardinality: targets the full collection or a batch. For a single item by ID, use getGlobalEnumeration instead.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| page[size] | number | no | Maximum number of items to return in this page (e.g. 100). Use together with page[number] to paginate through a large result set. |
| page[number] | number | no | 1-based page number to fetch when the result set is paginated (e.g. 2 for the second page). Combine with page[size]; omit to fetch the first page. |
| fields | object | no | Sparse fieldset selector: an object keyed by resource type (e.g. workitems) whose value is a comma-separated list of attribute names to return (e.g. id,title,status), reducing payload size. Omit t |
| response_format | string | no | Response detail level. concise removes redundant HTML and JSON:API metadata and may use a small default fieldset on large lists; detailed preserves the complete response. Defaults to detailed. |
| max_items | integer | no | Collect up to this many results across pages (maximum 1000). Omit to fetch only the requested page, as before. |
Creates a list of Enumerations in the Global context. Scope: spans every project (no project filter). To act on a single project, use postProjectEnumeration instead. Effect: creates a new resource. Repeating this call may create additional resources; it is not guaranteed idempotent. Tip: set…
| Parameter | Type | Required | Notes |
|---|---|---|---|
| requestBody | object | yes | The Enumeration(s) body. |
| dry_run | boolean | no | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually |
Returns the specified Enumeration from the Global context. Scope: spans every project (no project filter). To act on a single project, use getProjectEnumeration instead. Cardinality: targets a single item by ID. For the full collection or a batch, use getGlobalEnumerations instead. Selection:…
| Parameter | Type | Required | Notes |
|---|---|---|---|
| enumContext | string | yes | The Enumeration context. (Allowed values are '~', 'plans', 'testing' and 'documents'. Use '~' for Work Item or general enumerations.) |
| enumName | string | yes | The Enumeration Name. |
| targetType | string | yes | The configured subtype for this enumeration or custom field (e.g. requirement for a Work Item type). Use ~ (without quotes) when the configuration applies to every subtype. |
| fields | object | no | Sparse fieldset selector: an object keyed by resource type (e.g. workitems) whose value is a comma-separated list of attribute names to return (e.g. id,title,status), reducing payload size. Omit t |
| include | string | no | Comma-separated list of related resource types to embed in the response (e.g. author,attachments) so they don't require a separate follow-up call. Omit to return only the primary resource. |
| response_format | string | no | Response detail level. concise removes redundant HTML and JSON:API metadata and may use a small default fieldset on large lists; detailed preserves the complete response. Defaults to detailed. |
Deletes the specified Enumeration from the Global context. Scope: spans every project (no project filter). To act on a single project, use deleteProjectEnumeration instead. Effect: irreversible — data removed or overwritten by this call cannot be recovered through the API. Tip: set `dry_run:…
| Parameter | Type | Required | Notes |
|---|---|---|---|
| enumContext | string | yes | The Enumeration context. (Allowed values are '~', 'plans', 'testing' and 'documents'. Use '~' for Work Item or general enumerations.) |
| enumName | string | yes | The Enumeration Name. |
| targetType | string | yes | The configured subtype for this enumeration or custom field (e.g. requirement for a Work Item type). Use ~ (without quotes) when the configuration applies to every subtype. |
| dry_run | boolean | no | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually |
Replaces the entire option list of one global Enumeration: options missing from requestBody are deleted, not merged. Read the current list with getGlobalEnumeration first and send every option you want to keep. Scope: spans every project (no project filter). To act on a single project, use…
| Parameter | Type | Required | Notes |
|---|---|---|---|
| enumContext | string | yes | The Enumeration context. (Allowed values are '~', 'plans', 'testing' and 'documents'. Use '~' for Work Item or general enumerations.) |
| enumName | string | yes | The Enumeration Name. |
| targetType | string | yes | The configured subtype for this enumeration or custom field (e.g. requirement for a Work Item type). Use ~ (without quotes) when the configuration applies to every subtype. |
| requestBody | object | yes | The Enumeration(s) body. |
| dry_run | boolean | no | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually |
Returns a list of Icons from the default context. Cardinality: targets the full collection or a batch. For a single item by ID, use getDefaultIcon instead.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| page[size] | number | no | Maximum number of items to return in this page (e.g. 100). Use together with page[number] to paginate through a large result set. |
| page[number] | number | no | 1-based page number to fetch when the result set is paginated (e.g. 2 for the second page). Combine with page[size]; omit to fetch the first page. |
| fields | object | no | Sparse fieldset selector: an object keyed by resource type (e.g. workitems) whose value is a comma-separated list of attribute names to return (e.g. id,title,status), reducing payload size. Omit t |
| response_format | string | no | Response detail level. concise removes redundant HTML and JSON:API metadata and may use a small default fieldset on large lists; detailed preserves the complete response. Defaults to detailed. |
| max_items | integer | no | Collect up to this many results across pages (maximum 1000). Omit to fetch only the requested page, as before. |
Returns the specified Icon from the default context. Cardinality: targets a single item by ID. For the full collection or a batch, use getDefaultIcons instead.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| iconId | string | yes | The icon's ID, as returned by the corresponding icon-listing endpoint (getDefaultIcons/getGlobalIcons/getProjectIcons). |
| fields | object | no | Sparse fieldset selector: an object keyed by resource type (e.g. workitems) whose value is a comma-separated list of attribute names to return (e.g. id,title,status), reducing payload size. Omit t |
| response_format | string | no | Response detail level. concise removes redundant HTML and JSON:API metadata and may use a small default fieldset on large lists; detailed preserves the complete response. Defaults to detailed. |
Returns a list of Icons from the Global context. Scope: spans every project (no project filter). To act on a single project, use getProjectIcons instead. Cardinality: targets the full collection or a batch. For a single item by ID, use getGlobalIcon instead.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| page[size] | number | no | Maximum number of items to return in this page (e.g. 100). Use together with page[number] to paginate through a large result set. |
| page[number] | number | no | 1-based page number to fetch when the result set is paginated (e.g. 2 for the second page). Combine with page[size]; omit to fetch the first page. |
| fields | object | no | Sparse fieldset selector: an object keyed by resource type (e.g. workitems) whose value is a comma-separated list of attribute names to return (e.g. id,title,status), reducing payload size. Omit t |
| response_format | string | no | Response detail level. concise removes redundant HTML and JSON:API metadata and may use a small default fieldset on large lists; detailed preserves the complete response. Defaults to detailed. |
| max_items | integer | no | Collect up to this many results across pages (maximum 1000). Omit to fetch only the requested page, as before. |
Icons are identified by order. Scope: spans every project (no project filter). To act on a single project, use postProjectIcons instead. Effect: creates a new resource. Repeating this call may create additional resources; it is not guaranteed idempotent. Tip: set dry_run: true first to…
| Parameter | Type | Required | Notes |
|---|---|---|---|
| requestBody | string | yes | Icon meta data and file data |
| dry_run | boolean | no | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually |
Returns the specified Icon from the Global context. Scope: spans every project (no project filter). To act on a single project, use getProjectIcon instead. Cardinality: targets a single item by ID. For the full collection or a batch, use getGlobalIcons instead.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| iconId | string | yes | The icon's ID, as returned by the corresponding icon-listing endpoint (getDefaultIcons/getGlobalIcons/getProjectIcons). |
| fields | object | no | Sparse fieldset selector: an object keyed by resource type (e.g. workitems) whose value is a comma-separated list of attribute names to return (e.g. id,title,status), reducing payload size. Omit t |
| response_format | string | no | Response detail level. concise removes redundant HTML and JSON:API metadata and may use a small default fieldset on large lists; detailed preserves the complete response. Defaults to detailed. |
Returns the list of Jobs. Cardinality: targets the full collection or a batch. For a single item by ID, use getJob instead.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| page[size] | number | no | Maximum number of items to return in this page (e.g. 100). Use together with page[number] to paginate through a large result set. |
| page[number] | number | no | 1-based page number to fetch when the result set is paginated (e.g. 2 for the second page). Combine with page[size]; omit to fetch the first page. |
| fields | object | no | Sparse fieldset selector: an object keyed by resource type (e.g. workitems) whose value is a comma-separated list of attribute names to return (e.g. id,title,status), reducing payload size. Omit t |
| include | string | no | Comma-separated list of related resource types to embed in the response (e.g. author,attachments) so they don't require a separate follow-up call. Omit to return only the primary resource. |
| projectId | string | no | The Polarion project ID (its URL segment, e.g. myproject), case-sensitive. Required to scope the request to one project. If the ID is unknown, ask the user; getProjects lists IDs only with global re |
| response_format | string | no | Response detail level. concise removes redundant HTML and JSON:API metadata and may use a small default fieldset on large lists; detailed preserves the complete response. Defaults to detailed. |
| max_items | integer | no | Collect up to this many results across pages (maximum 1000). Omit to fetch only the requested page, as before. |
Returns the specified Job. Cardinality: targets a single item by ID. For the full collection or a batch, use getJobs instead. Examples: {"jobId":"job-123"}.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| jobId | string | yes | The asynchronous job's ID, returned when the triggering call responds with a jobs resource. Poll getJob with this ID to check completion status. |
| fields | object | no | Sparse fieldset selector: an object keyed by resource type (e.g. workitems) whose value is a comma-separated list of attribute names to return (e.g. id,title,status), reducing payload size. Omit t |
| include | string | no | Comma-separated list of related resource types to embed in the response (e.g. author,attachments) so they don't require a separate follow-up call. Omit to return only the primary resource. |
| response_format | string | no | Response detail level. concise removes redundant HTML and JSON:API metadata and may use a small default fieldset on large lists; detailed preserves the complete response. Defaults to detailed. |
Downloads one result file produced by a finished asynchronous job (e.g. the spreadsheet from getExportExcelTests). Images (PNG, JPEG, GIF, WebP) come back as image content, UTF-8 text files as text, and any other file (PDF, Office, ZIP) as an embedded base64 resource; files over 20 MB are refused.…
| Parameter | Type | Required | Notes |
|---|---|---|---|
| jobId | string | yes | The asynchronous job's ID, returned when the triggering call responds with a jobs resource. Poll getJob with this ID to check completion status. |
| filename | string | yes | The Download File Name. |
| response_format | string | no | Response detail level. concise removes redundant HTML and JSON:API metadata and may use a small default fieldset on large lists; detailed preserves the complete response. Defaults to detailed. |
Downloads the plain-text execution log for one asynchronous Polarion job. Call after getJob reports a terminal state because a running job may have an incomplete log; jobId comes from the jobs resource returned by the operation that started it. Use getJobResultFileContent for produced…
| Parameter | Type | Required | Notes |
|---|---|---|---|
| jobId | string | yes | The asynchronous job's ID, returned when the triggering call responds with a jobs resource. Poll getJob with this ID to check completion status. |
| response_format | string | no | Response detail level. concise removes redundant HTML and JSON:API metadata and may use a small default fieldset on large lists; detailed preserves the complete response. Defaults to detailed. |
Starts a Polarion asynchronous job and returns its jobs resource; this response means the job was accepted, not that it finished. Poll getJob with the returned job ID, then use getJobLogContent or getJobResultFileContent after completion. Use run_job_and_wait when bounded polling and a…
| Parameter | Type | Required | Notes |
|---|---|---|---|
| requestBody | object | yes | Execute Job parameters. |
| dry_run | boolean | no | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually |
Returns the server-wide license limits as current count vs. maximum for Work Items, Documents/Pages, and projects, plus links to the default license slots. Use it to check remaining capacity before bulk-creating items or projects; for which user holds which license use getLicenseAssignments, and…
| Parameter | Type | Required | Notes |
|---|---|---|---|
| fields | object | no | Sparse fieldset selector: an object keyed by resource type (e.g. workitems) whose value is a comma-separated list of attribute names to return (e.g. id,title,status), reducing payload size. Omit t |
| include | string | no | Comma-separated list of related resource types to embed in the response (e.g. author,attachments) so they don't require a separate follow-up call. Omit to return only the primary resource. |
| response_format | string | no | Response detail level. concise removes redundant HTML and JSON:API metadata and may use a small default fieldset on large lists; detailed preserves the complete response. Defaults to detailed. |
Updates the server license configuration from the supplied request body. This is a global administrative change requiring license administration permission. Inspect capacity with getLicense and assignments with getLicenseSlots first. Effect: idempotent — calling it again with the same input…
| Parameter | Type | Required | Notes |
|---|---|---|---|
| requestBody | object | yes | The License body. |
| dry_run | boolean | no | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually |
Returns a list of License Assignments. (Not supported by cloud-based Polarion X.). Cardinality: targets the full collection or a batch. For a single item by ID, use getLicenseAssignmentsForUser instead.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| page[size] | number | no | Maximum number of items to return in this page (e.g. 100). Use together with page[number] to paginate through a large result set. |
| page[number] | number | no | 1-based page number to fetch when the result set is paginated (e.g. 2 for the second page). Combine with page[size]; omit to fetch the first page. |
| fields | object | no | Sparse fieldset selector: an object keyed by resource type (e.g. workitems) whose value is a comma-separated list of attribute names to return (e.g. id,title,status), reducing payload size. Omit t |
| include | string | no | Comma-separated list of related resource types to embed in the response (e.g. author,attachments) so they don't require a separate follow-up call. Omit to return only the primary resource. |
| activeOnly | boolean | no | If set to true, only active (with status LOGGED_IN or EXPIRING) License Assignments will be returned, otherwise all the License Assignments will be returned. |
| response_format | string | no | Response detail level. concise removes redundant HTML and JSON:API metadata and may use a small default fieldset on large lists; detailed preserves the complete response. Defaults to detailed. |
| max_items | integer | no | Collect up to this many results across pages (maximum 1000). Omit to fetch only the requested page, as before. |
Updates the License Assignments of multiple users. (Not supported by cloud-based Polarion X.). Cardinality: targets the full collection or a batch. For a single item by ID, use patchLicenseAssignment instead. Effect: idempotent — calling it again with the same input leaves the resource in the…
| Parameter | Type | Required | Notes |
|---|---|---|---|
| requestBody | object | yes | The User(s) License Assignment body. |
| dry_run | boolean | no | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually |
Returns the specified License Assignment. (Not supported by cloud-based Polarion X.). Cardinality: targets a single item by ID. For the full collection or a batch, use getLicenseAssignments instead.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| userId | string | yes | — |
| fields | object | no | Sparse fieldset selector: an object keyed by resource type (e.g. workitems) whose value is a comma-separated list of attribute names to return (e.g. id,title,status), reducing payload size. Omit t |
| include | string | no | Comma-separated list of related resource types to embed in the response (e.g. author,attachments) so they don't require a separate follow-up call. Omit to return only the primary resource. |
| response_format | string | no | Response detail level. concise removes redundant HTML and JSON:API metadata and may use a small default fieldset on large lists; detailed preserves the complete response. Defaults to detailed. |
Updates a user's License Assignment. (Not supported by cloud-based Polarion X.). Cardinality: targets a single item by ID. For the full collection or a batch, use patchLicenseAssignments instead. Effect: idempotent — calling it again with the same input leaves the resource in the same end state,…
| Parameter | Type | Required | Notes |
|---|---|---|---|
| userId | string | yes | The User ID. |
| requestBody | object | yes | The User License Assignment body. |
| dry_run | boolean | no | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually |
Returns information on the available License Slots. (Not supported by cloud-based Polarion X.). Cardinality: targets the full collection or a batch. For a single item by ID, use getLicenseSlot instead.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| typeId | string | yes | — |
| page[size] | number | no | Maximum number of items to return in this page (e.g. 100). Use together with page[number] to paginate through a large result set. |
| page[number] | number | no | 1-based page number to fetch when the result set is paginated (e.g. 2 for the second page). Combine with page[size]; omit to fetch the first page. |
| fields | object | no | Sparse fieldset selector: an object keyed by resource type (e.g. workitems) whose value is a comma-separated list of attribute names to return (e.g. id,title,status), reducing payload size. Omit t |
| include | string | no | Comma-separated list of related resource types to embed in the response (e.g. author,attachments) so they don't require a separate follow-up call. Omit to return only the primary resource. |
| revision | string | no | A specific repository revision (e.g. 1234) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision. |
| response_format | string | no | Response detail level. concise removes redundant HTML and JSON:API metadata and may use a small default fieldset on large lists; detailed preserves the complete response. Defaults to detailed. |
| max_items | integer | no | Collect up to this many results across pages (maximum 1000). Omit to fetch only the requested page, as before. |
Creates a list of group License Slots. (Not supported by cloud-based Polarion X.). Effect: creates a new resource. Repeating this call may create additional resources; it is not guaranteed idempotent. Tip: set dry_run: true first to validate the arguments and preview the exact request without…
| Parameter | Type | Required | Notes |
|---|---|---|---|
| typeId | string | yes | — |
| requestBody | object | yes | License Slots body. |
| dry_run | boolean | no | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually |
Deletes specified license slots from the Polarion server. This is a server-wide administrative change requiring license administration permission. Read current assignments with getLicenseSlots and capacity with getLicense before removal. Effect: irreversible — data removed or overwritten by…
| Parameter | Type | Required | Notes |
|---|---|---|---|
| typeId | string | yes | License type. |
| requestBody | object | yes | No Content |
| dry_run | boolean | no | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually |
Returns the specified License Slot. (Not supported by cloud-based Polarion X.). Cardinality: targets a single item by ID. For the full collection or a batch, use getLicenseSlots instead.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| typeId | string | yes | — |
| model | string | yes | — |
| group | string | yes | — |
| fields | object | no | Sparse fieldset selector: an object keyed by resource type (e.g. workitems) whose value is a comma-separated list of attribute names to return (e.g. id,title,status), reducing payload size. Omit t |
| include | string | no | Comma-separated list of related resource types to embed in the response (e.g. author,attachments) so they don't require a separate follow-up call. Omit to return only the primary resource. |
| response_format | string | no | Response detail level. concise removes redundant HTML and JSON:API metadata and may use a small default fieldset on large lists; detailed preserves the complete response. Defaults to detailed. |
Returns the Large Language Models configured on this Polarion server for its built-in AI features (ID and name), paginated. Call it before generateCompletion to pick a valid model; an empty list means no LLM is configured and AI actions will fail.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| page[size] | number | no | Maximum number of items to return in this page (e.g. 100). Use together with page[number] to paginate through a large result set. |
| page[number] | number | no | 1-based page number to fetch when the result set is paginated (e.g. 2 for the second page). Combine with page[size]; omit to fetch the first page. |
| response_format | string | no | Response detail level. concise removes redundant HTML and JSON:API metadata and may use a small default fieldset on large lists; detailed preserves the complete response. Defaults to detailed. |
Generates a chat completion using a Large Language Model (LLM). Effect: triggers a server-side action rather than a plain resource creation — whether repeating it is safe, a no-op, or rejected depends on the specific action; treat it as not guaranteed idempotent. Tip: set dry_run: true first to…
| Parameter | Type | Required | Notes |
|---|---|---|---|
| requestBody | object | yes | Generate completion parameters. |
| dry_run | boolean | no | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually |
Returns server-wide Polarion REST metadata available to REST API users. Use this for global field/configuration definitions; use getProjectFieldsMetadata for a project’s effective resource fields and getFieldsMetadataForWorkItem for fields on a specific Work Item.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| fields | object | no | Sparse fieldset selector: an object keyed by resource type (e.g. workitems) whose value is a comma-separated list of attribute names to return (e.g. id,title,status), reducing payload size. Omit t |
| include | string | no | Comma-separated list of related resource types to embed in the response (e.g. author,attachments) so they don't require a separate follow-up call. Omit to return only the primary resource. |
| response_format | string | no | Response detail level. concise removes redundant HTML and JSON:API metadata and may use a small default fieldset on large lists; detailed preserves the complete response. Defaults to detailed. |
Lists Rich Pages across repository spaces, subject to the signed-in user’s global repository read permissions; returns an empty page when no matching pages are visible. Use getSpacePages for a known space, getRepositorySpacePages for one repository space, or getPages for a project space.…
| Parameter | Type | Required | Notes |
|---|---|---|---|
| page[size] | number | no | Maximum number of items to return in this page (e.g. 100). Use together with page[number] to paginate through a large result set. |
| page[number] | number | no | 1-based page number to fetch when the result set is paginated (e.g. 2 for the second page). Combine with page[size]; omit to fetch the first page. |
| fields | object | no | Sparse fieldset selector: an object keyed by resource type (e.g. workitems) whose value is a comma-separated list of attribute names to return (e.g. id,title,status), reducing payload size. Omit t |
| include | string | no | Comma-separated list of related resource types to embed in the response (e.g. author,attachments) so they don't require a separate follow-up call. Omit to return only the primary resource. |
| query | string | no | Polarion Lucene-style query string to filter results: field:value clauses combined with AND/OR, phrases in quotes. Exact supported field names depend on the resource type being queried. |
| sort | string | no | Comma-separated list of fields to sort by, in priority order; prefix a field with - for descending order (e.g. -updated,title). |
| response_format | string | no | Response detail level. concise removes redundant HTML and JSON:API metadata and may use a small default fieldset on large lists; detailed preserves the complete response. Defaults to detailed. |
| max_items | integer | no | Collect up to this many results across pages (maximum 1000). Omit to fetch only the requested page, as before. |
Returns a list of Projects. Cardinality: targets the full collection or a batch. For a single item by ID, use getProject instead. Examples: {"query":"active:true","page[size]":20}.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| page[size] | number | no | Maximum number of items to return in this page (e.g. 100). Use together with page[number] to paginate through a large result set. |
| page[number] | number | no | 1-based page number to fetch when the result set is paginated (e.g. 2 for the second page). Combine with page[size]; omit to fetch the first page. |
| fields | object | no | Sparse fieldset selector: an object keyed by resource type (e.g. workitems) whose value is a comma-separated list of attribute names to return (e.g. id,title,status), reducing payload size. Omit t |
| include | string | no | Comma-separated list of related resource types to embed in the response (e.g. author,attachments) so they don't require a separate follow-up call. Omit to return only the primary resource. |
| query | string | no | Polarion Lucene-style query string to filter results: field:value clauses combined with AND/OR, phrases in quotes. Exact supported field names depend on the resource type being queried. |
| sort | string | no | Comma-separated list of fields to sort by, in priority order; prefix a field with - for descending order (e.g. -updated,title). |
| revision | string | no | A specific repository revision (e.g. 1234) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision. |
| response_format | string | no | Response detail level. concise removes redundant HTML and JSON:API metadata and may use a small default fieldset on large lists; detailed preserves the complete response. Defaults to detailed. |
| max_items | integer | no | Collect up to this many results across pages (maximum 1000). Omit to fetch only the requested page, as before. |
Returns the specified Project. Cardinality: targets a single item by ID. For the full collection or a batch, use getProjects instead.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| projectId | string | yes | The Polarion project ID (its URL segment, e.g. myproject), case-sensitive. Required to scope the request to one project. If the ID is unknown, ask the user; getProjects lists IDs only with global re |
| fields | object | no | Sparse fieldset selector: an object keyed by resource type (e.g. workitems) whose value is a comma-separated list of attribute names to return (e.g. id,title,status), reducing payload size. Omit t |
| include | string | no | Comma-separated list of related resource types to embed in the response (e.g. author,attachments) so they don't require a separate follow-up call. Omit to return only the primary resource. |
| revision | string | no | A specific repository revision (e.g. 1234) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision. |
| response_format | string | no | Response detail level. concise removes redundant HTML and JSON:API metadata and may use a small default fieldset on large lists; detailed preserves the complete response. Defaults to detailed. |
Permanently deletes a Polarion project and its project data, including contained resources; this cannot be recovered through the API. Requires project deletion permission. Use dry_run to preview the request, and use unmarkProject when the project data should remain in the repository. Effect:…
| Parameter | Type | Required | Notes |
|---|---|---|---|
| projectId | string | yes | The Polarion project ID (its URL segment, e.g. myproject), case-sensitive. Required to scope the request to one project. If the ID is unknown, ask the user; getProjects lists IDs only with global re |
| dry_run | boolean | no | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually |
Updates one Polarion project’s attributes from the supplied JSON:API request body. Requires project administration permission. Use getProject to inspect current values and deleteProject only to remove the project. Effect: idempotent — calling it again with the same input leaves the resource in…
| Parameter | Type | Required | Notes |
|---|---|---|---|
| projectId | string | yes | The Polarion project ID (its URL segment, e.g. myproject), case-sensitive. Required to scope the request to one project. If the ID is unknown, ask the user; getProjects lists IDs only with global re |
| requestBody | object | yes | The Project body. |
| dry_run | boolean | no | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually |
Returns fields for the resource type and its target type in the Project context. Scope: one project (requires a project ID). To act across all projects, use getGlobalFieldsMetadata instead.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| projectId | string | yes | The Polarion project ID (its URL segment, e.g. myproject), case-sensitive. Required to scope the request to one project. If the ID is unknown, ask the user; getProjects lists IDs only with global re |
| resourceType | string | yes | The Resource Type. |
| targetType | string | no | The configured subtype for this enumeration or custom field (e.g. requirement for a Work Item type). Use ~ (without quotes) when the configuration applies to every subtype. |
| response_format | string | no | Response detail level. concise removes redundant HTML and JSON:API metadata and may use a small default fieldset on large lists; detailed preserves the complete response. Defaults to detailed. |
Moves project to a different location. Effect: irreversible — data removed or overwritten by this call cannot be recovered through the API. Tip: set dry_run: true first to validate the arguments and preview the exact request without sending it to Polarion. The executor returns this preview as…
| Parameter | Type | Required | Notes |
|---|---|---|---|
| projectId | string | yes | The Polarion project ID (its URL segment, e.g. myproject), case-sensitive. Required to scope the request to one project. If the ID is unknown, ask the user; getProjects lists IDs only with global re |
| requestBody | object | yes | Move project parameters. |
| dry_run | boolean | no | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually |
Removes the Polarion project marker from a project so it no longer appears or works as a project, while its data stays in the repository and can be re-registered later with markProject. Runs as an asynchronous job and returns a jobs resource; poll getJob until it finishes. Use it to retire a…
| Parameter | Type | Required | Notes |
|---|---|---|---|
| projectId | string | yes | The Polarion project ID (its URL segment, e.g. myproject), case-sensitive. Required to scope the request to one project. If the ID is unknown, ask the user; getProjects lists IDs only with global re |
| dry_run | boolean | no | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually |
Returns a list of Collections. Cardinality: targets the full collection or a batch. For a single item by ID, use getCollection instead.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| projectId | string | yes | The Polarion project ID (its URL segment, e.g. myproject), case-sensitive. Required to scope the request to one project. If the ID is unknown, ask the user; getProjects lists IDs only with global re |
| page[size] | number | no | Maximum number of items to return in this page (e.g. 100). Use together with page[number] to paginate through a large result set. |
| page[number] | number | no | 1-based page number to fetch when the result set is paginated (e.g. 2 for the second page). Combine with page[size]; omit to fetch the first page. |
| fields | object | no | Sparse fieldset selector: an object keyed by resource type (e.g. workitems) whose value is a comma-separated list of attribute names to return (e.g. id,title,status), reducing payload size. Omit t |
| include | string | no | Comma-separated list of related resource types to embed in the response (e.g. author,attachments) so they don't require a separate follow-up call. Omit to return only the primary resource. |
| query | string | no | Polarion Lucene-style query string to filter results: field:value clauses combined with AND/OR, phrases in quotes. Exact supported field names depend on the resource type being queried. |
| sort | string | no | Comma-separated list of fields to sort by, in priority order; prefix a field with - for descending order (e.g. -updated,title). |
| revision | string | no | A specific repository revision (e.g. 1234) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision. |
| response_format | string | no | Response detail level. concise removes redundant HTML and JSON:API metadata and may use a small default fieldset on large lists; detailed preserves the complete response. Defaults to detailed. |
| max_items | integer | no | Collect up to this many results across pages (maximum 1000). Omit to fetch only the requested page, as before. |
Creates Collections from the supplied JSON:API resource data and returns the created resources. Requires project permission to create Collections. Use getCollections to list existing ones or patchCollections to update one. Effect: creates a new resource. Repeating this call may create…
| Parameter | Type | Required | Notes |
|---|---|---|---|
| projectId | string | yes | The Polarion project ID (its URL segment, e.g. myproject), case-sensitive. Required to scope the request to one project. If the ID is unknown, ask the user; getProjects lists IDs only with global re |
| requestBody | object | yes | The Collection(s) body. |
| dry_run | boolean | no | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually |
Deletes a list of Collections. Cardinality: targets the full collection or a batch. For a single item by ID, use deleteCollection instead. Effect: irreversible — data removed or overwritten by this call cannot be recovered through the API. Tip: set dry_run: true first to validate the arguments…
| Parameter | Type | Required | Notes |
|---|---|---|---|
| projectId | string | yes | The Polarion project ID (its URL segment, e.g. myproject), case-sensitive. Required to scope the request to one project. If the ID is unknown, ask the user; getProjects lists IDs only with global re |
| requestBody | object | yes | The Collection(s) body. |
| dry_run | boolean | no | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually |
Returns the specified Collection. Cardinality: targets a single item by ID. For the full collection or a batch, use getCollections instead.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| projectId | string | yes | The Polarion project ID (its URL segment, e.g. myproject), case-sensitive. Required to scope the request to one project. If the ID is unknown, ask the user; getProjects lists IDs only with global re |
| collectionId | string | yes | The Collection ID. |
| fields | object | no | Sparse fieldset selector: an object keyed by resource type (e.g. workitems) whose value is a comma-separated list of attribute names to return (e.g. id,title,status), reducing payload size. Omit t |
| include | string | no | Comma-separated list of related resource types to embed in the response (e.g. author,attachments) so they don't require a separate follow-up call. Omit to return only the primary resource. |
| revision | string | no | A specific repository revision (e.g. 1234) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision. |
| response_format | string | no | Response detail level. concise removes redundant HTML and JSON:API metadata and may use a small default fieldset on large lists; detailed preserves the complete response. Defaults to detailed. |
Deletes the specified Collection. Cardinality: targets a single item by ID. For the full collection or a batch, use deleteCollections instead. Effect: irreversible — data removed or overwritten by this call cannot be recovered through the API. Tip: set dry_run: true first to validate the…
| Parameter | Type | Required | Notes |
|---|---|---|---|
| projectId | string | yes | The Polarion project ID (its URL segment, e.g. myproject), case-sensitive. Required to scope the request to one project. If the ID is unknown, ask the user; getProjects lists IDs only with global re |
| collectionId | string | yes | The Collection ID. |
| dry_run | boolean | no | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually |
Updates one Collection’s attributes from the supplied JSON:API request body. Use patchCollectionsRelationships for linkage changes or postCollections to create another Collection. Effect: idempotent — calling it again with the same input leaves the resource in the same end state, with no…
| Parameter | Type | Required | Notes |
|---|---|---|---|
| projectId | string | yes | The Polarion project ID (its URL segment, e.g. myproject), case-sensitive. Required to scope the request to one project. If the ID is unknown, ask the user; getProjects lists IDs only with global re |
| collectionId | string | yes | The Collection ID. |
| requestBody | object | yes | The Collection(s) body. |
| dry_run | boolean | no | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually |
Closes one Collection, changing its lifecycle state while retaining its contents. Requires permission to update the Collection. Use reopenCollection to make a closed Collection active again, or reuseCollection when continuing its contents as a new cycle. Effect: triggers a server-side action…
| Parameter | Type | Required | Notes |
|---|---|---|---|
| projectId | string | yes | The Polarion project ID (its URL segment, e.g. myproject), case-sensitive. Required to scope the request to one project. If the ID is unknown, ask the user; getProjects lists IDs only with global re |
| collectionId | string | yes | The Collection ID. |
| dry_run | boolean | no | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually |
Returns the field definitions that apply to one specific Collection, keyed by field ID: each field's label and type kind (primitive such as string/date/text/html, list, structure, or enumeration with its enum name), including the custom fields configured for its type. Use it before writing…
| Parameter | Type | Required | Notes |
|---|---|---|---|
| projectId | string | yes | The Polarion project ID (its URL segment, e.g. myproject), case-sensitive. Required to scope the request to one project. If the ID is unknown, ask the user; getProjects lists IDs only with global re |
| collectionId | string | yes | The Collection ID. |
| response_format | string | no | Response detail level. concise removes redundant HTML and JSON:API metadata and may use a small default fieldset on large lists; detailed preserves the complete response. Defaults to detailed. |
Reopens one previously closed Collection so it can be used again. Requires permission to update the Collection. Use closeCollection to close an active one or reuseCollection to start a new cycle while preserving the earlier state. Effect: triggers a server-side action rather than a plain…
| Parameter | Type | Required | Notes |
|---|---|---|---|
| projectId | string | yes | The Polarion project ID (its URL segment, e.g. myproject), case-sensitive. Required to scope the request to one project. If the ID is unknown, ask the user; getProjects lists IDs only with global re |
| collectionId | string | yes | The Collection ID. |
| dry_run | boolean | no | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually |
Starts a new use cycle for one Collection while retaining the existing collection history. Requires a valid Collection and update permission. Use reopenCollection to reactivate the same closed cycle or copyCollection when a separate Collection is needed. Effect: triggers a server-side action…
| Parameter | Type | Required | Notes |
|---|---|---|---|
| projectId | string | yes | The Polarion project ID (its URL segment, e.g. myproject), case-sensitive. Required to scope the request to one project. If the ID is unknown, ask the user; getProjects lists IDs only with global re |
| collectionId | string | yes | The Collection ID. |
| revision | string | no | A specific repository revision (e.g. 1234) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision. |
| requestBody | object | yes | Reusing parameters. |
| dry_run | boolean | no | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually |
Returns the resource identifiers linked from one Collection through a single named relationship, as JSON:API linkage ({type, id} entries) without the related resources' attributes. relationshipId is the relationship's name, not an entry ID. Use this to inspect one relationship cheaply; to read…
| Parameter | Type | Required | Notes |
|---|---|---|---|
| projectId | string | yes | The Polarion project ID (its URL segment, e.g. myproject), case-sensitive. Required to scope the request to one project. If the ID is unknown, ask the user; getProjects lists IDs only with global re |
| collectionId | string | yes | The Collection ID. |
| relationshipId | string | yes | The relationship's name as it appears under relationships in the owning resource (e.g. assignee, author, watches, linkedWorkItems), not an ID of an individual link entry. |
| page[size] | number | no | Maximum number of items to return in this page (e.g. 100). Use together with page[number] to paginate through a large result set. |
| page[number] | number | no | 1-based page number to fetch when the result set is paginated (e.g. 2 for the second page). Combine with page[size]; omit to fetch the first page. |
| fields | object | no | Sparse fieldset selector: an object keyed by resource type (e.g. workitems) whose value is a comma-separated list of attribute names to return (e.g. id,title,status), reducing payload size. Omit t |
| include | string | no | Comma-separated list of related resource types to embed in the response (e.g. author,attachments) so they don't require a separate follow-up call. Omit to return only the primary resource. |
| revision | string | no | A specific repository revision (e.g. 1234) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision. |
| response_format | string | no | Response detail level. concise removes redundant HTML and JSON:API metadata and may use a small default fieldset on large lists; detailed preserves the complete response. Defaults to detailed. |
Adds relationship links to one Collection without replacing its other links. Provide JSON:API linkage; use getCollectionsRelationship to inspect the set or patchCollectionsRelationships to replace it. Effect: creates a new resource. Repeating this call may create additional resources; it is…
| Parameter | Type | Required | Notes |
|---|---|---|---|
| projectId | string | yes | The Polarion project ID (its URL segment, e.g. myproject), case-sensitive. Required to scope the request to one project. If the ID is unknown, ask the user; getProjects lists IDs only with global re |
| collectionId | string | yes | The Collection ID. |
| relationshipId | string | yes | The relationship's name as it appears under relationships in the owning resource (e.g. assignee, author, watches, linkedWorkItems), not an ID of an individual link entry. |
| requestBody | object | yes | The Document(s) body. |
| dry_run | boolean | no | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually |
Removes the named relationship from one Collection; the related resource itself is not deleted. Read current links with getCollectionsRelationship; use postCollectionsRelationships to add links or patchCollectionsRelationships to replace the relationship set. Effect: irreversible — data…
| Parameter | Type | Required | Notes |
|---|---|---|---|
| projectId | string | yes | The Polarion project ID (its URL segment, e.g. myproject), case-sensitive. Required to scope the request to one project. If the ID is unknown, ask the user; getProjects lists IDs only with global re |
| collectionId | string | yes | The Collection ID. |
| relationshipId | string | yes | The relationship's name as it appears under relationships in the owning resource (e.g. assignee, author, watches, linkedWorkItems), not an ID of an individual link entry. |
| requestBody | object | yes | The Relationship body. |
| dry_run | boolean | no | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually |
Replaces relationship linkage on one Collection with the supplied relationship data. Read existing links with getCollectionsRelationship; use postCollectionsRelationships to add links without replacing the full set. Effect: irreversible — data removed or overwritten by this call cannot be…
| Parameter | Type | Required | Notes |
|---|---|---|---|
| projectId | string | yes | The Polarion project ID (its URL segment, e.g. myproject), case-sensitive. Required to scope the request to one project. If the ID is unknown, ask the user; getProjects lists IDs only with global re |
| collectionId | string | yes | The Collection ID. |
| relationshipId | string | yes | The relationship's name as it appears under relationships in the owning resource (e.g. assignee, author, watches, linkedWorkItems), not an ID of an individual link entry. |
| requestBody | object | yes | The Relationship body. |
| dry_run | boolean | no | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually |
Creates a list of Custom Fields in the Project context. Scope: one project (requires a project ID). To act across all projects, use postGlobalCustomFields instead. Effect: creates a new resource. Repeating this call may create additional resources; it is not guaranteed idempotent. Tip: set…
| Parameter | Type | Required | Notes |
|---|---|---|---|
| projectId | string | yes | The Polarion project ID (its URL segment, e.g. myproject), case-sensitive. Required to scope the request to one project. If the ID is unknown, ask the user; getProjects lists IDs only with global re |
| requestBody | object | yes | Custom Fields Body |
| dry_run | boolean | no | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually |
Returns the defined Custom Fields for the resource type and target type in the Project context. Scope: one project (requires a project ID). To act across all projects, use getGlobalCustomFields instead.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| projectId | string | yes | The Polarion project ID (its URL segment, e.g. myproject), case-sensitive. Required to scope the request to one project. If the ID is unknown, ask the user; getProjects lists IDs only with global re |
| resourceType | string | yes | The Resource Type. |
| targetType | string | yes | The configured subtype for this enumeration or custom field (e.g. requirement for a Work Item type). Use ~ (without quotes) when the configuration applies to every subtype. |
| fields | object | no | Sparse fieldset selector: an object keyed by resource type (e.g. workitems) whose value is a comma-separated list of attribute names to return (e.g. id,title,status), reducing payload size. Omit t |
| include | string | no | Comma-separated list of related resource types to embed in the response (e.g. author,attachments) so they don't require a separate follow-up call. Omit to return only the primary resource. |
| response_format | string | no | Response detail level. concise removes redundant HTML and JSON:API metadata and may use a small default fieldset on large lists; detailed preserves the complete response. Defaults to detailed. |
Deletes the specified Custom Field configuration from the Project context. Scope: one project (requires a project ID). To act across all projects, use deleteGlobalCustomFields instead. Effect: irreversible — data removed or overwritten by this call cannot be recovered through the API. Tip: set…
| Parameter | Type | Required | Notes |
|---|---|---|---|
| projectId | string | yes | The Polarion project ID (its URL segment, e.g. myproject), case-sensitive. Required to scope the request to one project. If the ID is unknown, ask the user; getProjects lists IDs only with global re |
| resourceType | string | yes | The Resource Type. |
| targetType | string | yes | The configured subtype for this enumeration or custom field (e.g. requirement for a Work Item type). Use ~ (without quotes) when the configuration applies to every subtype. |
| dry_run | boolean | no | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually |
Replaces the entire list of Custom Fields of one project for one resource type and target type: fields missing from requestBody are deleted, not merged. Read the current list with getProjectCustomFields first and send every field you want to keep. Effect: irreversible — data removed or…
| Parameter | Type | Required | Notes |
|---|---|---|---|
| projectId | string | yes | The Polarion project ID (its URL segment, e.g. myproject), case-sensitive. Required to scope the request to one project. If the ID is unknown, ask the user; getProjects lists IDs only with global re |
| resourceType | string | yes | The Resource Type. |
| targetType | string | yes | The configured subtype for this enumeration or custom field (e.g. requirement for a Work Item type). Use ~ (without quotes) when the configuration applies to every subtype. |
| requestBody | object | yes | Custom Fields Body |
| dry_run | boolean | no | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually |
Returns a list of Documents from the Project context. Scope: one project (requires a project ID). To act across all projects, use getAllDocuments instead. Examples: {"projectId":"myproject","query":"title:Plan","page[size]":20}. Selection: Use getDocuments when listing Documents in one project;…
No parameter schema on file.
- Every tool, no call limit
- No card, and mcprush charges nothing for it
- Source published under MIT
- Runs on your machine — nothing of it reaches our gateway
- Nothing to cap, because mcprush bills nothing
What counts against your monthly calls
| Tool | Unit | Calls used | Out of the allowance |
|---|
Nothing here is billable: mcprush charges nothing to install Polarion or to call it, at any volume.
Two independent axes, because powerful and malicious are different questions. The grade is threat only. The capability level is blast radius, and it is never a penalty on the grade — it is priced as one subtract-only term in the score, where you can see it.
| Term | Level | What it prices | Points |
|---|---|---|---|
| capability-exposure | high | capability blast radius (high) — client exposure if the model is manipulated | −6 |
| verification-discount | source | publisher verification (provenance) — cryptographic build provenance ties the artifact to its source | −0 |
| coverage-honesty | source | inspection depth (source) — how much of the target the scan could see | −0 |
What the scan could actually read
A grade is only as meaningful as its coverage, so the scanner publishes its own depth before it publishes its result.
No tools were enumerated, so prompt-injection, capability and toxic-flow analysis had no tool surface to inspect. To grade a package’s real runtime tools, scan the running server: --command "npx -y <package>".
Capability — what it could do if the model were manipulated
Tags derived from each tool’s schema and the implementation, not from what the tool calls itself. high is the level these add up to.
| Tool | Capability tags | Why the tag was assigned |
|---|---|---|
| No per-tool rows for this release — see the note below. | ||
Toxic-flow graph
The lethal trifecta, checked as a graph rather than as a checklist: untrusted input, a sensitive source and an external sink have to meet before there is a path worth worrying about.
The public result for this release does not print the flow graph, so there is nothing to show here. That is not the same as "no paths were found": what the scan did read is above, under coverage.
Supply chain and provenance
This is the first scan of this surface here, so there is nothing yet to compare it against.
Every result on this tab comes from one deterministic pass over the published package — offline, rule by rule, and auditable line by line above. Same methodology version, same bytes, same score.
Release history
Always latest — the install command names no version, so it installs the newest release when it runs; the current release on file is 1.5.0. Pin a release below and the command asks for exactly that one.
No release note was published with this version.
One review per account, from a signed-in account that does not publish this listing. Nothing else is asked — you can say what you think before you install it. Publishers can reply once per review, and a review can be edited or deleted by whoever wrote it.
Any signed-in account that does not publish Polarion can review it, once — before installing it or after. A review from an account that has installed it is marked as one.
Nobody has reviewed this listing. The rating on the card is the mean of the reviews written here and nothing else, so there is no rating until somebody writes the first — which takes a signed-in account that does not publish it, and nothing else.