Polarion MCP Server

getFieldsMetadataForPlan

Read-only

Retrieve a Plan's valid field IDs, labels, and value types, including custom fields, to verify correct field keys before writing data to that Plan.

Instructions

Returns the field definitions that apply to one specific Plan, 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 to the Plan to learn which field keys and value types are valid. For the project-wide definitions of a resource type without a concrete instance, use getProjectFieldsMetadata; for global defaults, getGlobalFieldsMetadata.

Input Schema

Name	Required	Description	Default
`planId`	Yes	The Plan ID.
`projectId`	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 read access.
`response_format`	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.	detailed

Output Schema

Name	Required	Description	Default
`data`	No
`links`	No

Schema Changelog

Changes observed during successful MCP inspections.

Changed1 schema field changedv1.4.4Oct 29, 2026

changedInput schema / properties / projectId / description

Previous value: -"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs."New value: +"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 read access."

Changed1 schema field changedv1.4.0Oct 24, 2026

addedInput schema / properties / response_format

Added value: +{
+  "default": "detailed",
+  "description": "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.",
+  "enum": [
+    "concise",
+    "detailed"
+  ],
+  "type": "string"
+}

Changed54 schema fields changedv1.3.1Oct 22, 2026
- removedOutput schema / properties / data / properties / attributes / properties / enumField / properties / label / example
```
Removed value: -"field-label"
```
- changedOutput schema / properties / data / properties / attributes / properties / enumField / properties / label / type
```
Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- removedOutput schema / properties / data / properties / attributes / properties / enumField / properties / type / properties / enumContext / example
```
Removed value: -"enum-context"
```
- changedOutput schema / properties / data / properties / attributes / properties / enumField / properties / type / properties / enumContext / type
```
Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- removedOutput schema / properties / data / properties / attributes / properties / enumField / properties / type / properties / enumName / example
```
Removed value: -"enum-name"
```
- changedOutput schema / properties / data / properties / attributes / properties / enumField / properties / type / properties / enumName / type
```
Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- removedOutput schema / properties / data / properties / attributes / properties / enumField / properties / type / properties / kind / example
```
Removed value: -"enumeration"
```
- changedOutput schema / properties / data / properties / attributes / properties / enumField / properties / type / properties / kind / type
```
Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- changedOutput schema / properties / data / properties / attributes / properties / enumField / properties / type / type
```
Previous value: -"object"New value: +[
+  "object",
+  "null"
+]
```
- changedOutput schema / properties / data / properties / attributes / properties / enumField / type
```
Previous value: -"object"New value: +[
+  "object",
+  "null"
+]
```
- removedOutput schema / properties / data / properties / attributes / properties / listField / properties / label / example
```
Removed value: -"field-label"
```
- changedOutput schema / properties / data / properties / attributes / properties / listField / properties / label / type
```
Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- removedOutput schema / properties / data / properties / attributes / properties / listField / properties / type / properties / itemType / properties / kind / properties / enum / items / enum
```
Removed value: -[
-  "string",
-  "text",
-  "text/html",
-  "integer",
-  "float",
-  "currency",
-  "time",
-  "date",
-  "date-time",
-  "boolean",
-  "structure",
-  "relationship"
-]
```
- changedOutput schema / properties / data / properties / attributes / properties / listField / properties / type / properties / itemType / properties / kind / properties / enum / items / type
```
Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- changedOutput schema / properties / data / properties / attributes / properties / listField / properties / type / properties / itemType / properties / kind / properties / enum / type
```
Previous value: -"array"New value: +[
+  "array",
+  "null"
+]
```
- changedOutput schema / properties / data / properties / attributes / properties / listField / properties / type / properties / itemType / properties / kind / type
```
Previous value: -"object"New value: +[
+  "object",
+  "null"
+]
```
- changedOutput schema / properties / data / properties / attributes / properties / listField / properties / type / properties / itemType / type
```
Previous value: -"object"New value: +[
+  "object",
+  "null"
+]
```
- removedOutput schema / properties / data / properties / attributes / properties / listField / properties / type / properties / kind / example
```
Removed value: -"list"
```
- changedOutput schema / properties / data / properties / attributes / properties / listField / properties / type / properties / kind / type
```
Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- changedOutput schema / properties / data / properties / attributes / properties / listField / properties / type / type
```
Previous value: -"object"New value: +[
+  "object",
+  "null"
+]
```
- changedOutput schema / properties / data / properties / attributes / properties / listField / type
```
Previous value: -"object"New value: +[
+  "object",
+  "null"
+]
```
- removedOutput schema / properties / data / properties / attributes / properties / primitiveField / properties / label / example
```
Removed value: -"field-label"
```
- changedOutput schema / properties / data / properties / attributes / properties / primitiveField / properties / label / type
```
Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- removedOutput schema / properties / data / properties / attributes / properties / primitiveField / properties / type / properties / kind / properties / enum / items / enum
```
Removed value: -[
-  "string",
-  "text",
-  "text/html",
-  "integer",
-  "float",
-  "currency",
-  "time",
-  "date",
-  "date-time",
-  "boolean"
-]
```
- changedOutput schema / properties / data / properties / attributes / properties / primitiveField / properties / type / properties / kind / properties / enum / items / type
```
Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- changedOutput schema / properties / data / properties / attributes / properties / primitiveField / properties / type / properties / kind / properties / enum / type
```
Previous value: -"array"New value: +[
+  "array",
+  "null"
+]
```
- changedOutput schema / properties / data / properties / attributes / properties / primitiveField / properties / type / properties / kind / type
```
Previous value: -"object"New value: +[
+  "object",
+  "null"
+]
```
- changedOutput schema / properties / data / properties / attributes / properties / primitiveField / properties / type / type
```
Previous value: -"object"New value: +[
+  "object",
+  "null"
+]
```
- changedOutput schema / properties / data / properties / attributes / properties / primitiveField / type
```
Previous value: -"object"New value: +[
+  "object",
+  "null"
+]
```
- removedOutput schema / properties / data / properties / attributes / properties / structField / properties / label / example
```
Removed value: -"field-label"
```
- changedOutput schema / properties / data / properties / attributes / properties / structField / properties / label / type
```
Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- removedOutput schema / properties / data / properties / attributes / properties / structField / properties / type / properties / kind / example
```
Removed value: -"structure"
```
- changedOutput schema / properties / data / properties / attributes / properties / structField / properties / type / properties / kind / type
```
Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- removedOutput schema / properties / data / properties / attributes / properties / structField / properties / type / properties / structureName / example
```
Removed value: -"structureId"
```
- changedOutput schema / properties / data / properties / attributes / properties / structField / properties / type / properties / structureName / type
```
Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- changedOutput schema / properties / data / properties / attributes / properties / structField / properties / type / type
```
Previous value: -"object"New value: +[
+  "object",
+  "null"
+]
```
- changedOutput schema / properties / data / properties / attributes / properties / structField / type
```
Previous value: -"object"New value: +[
+  "object",
+  "null"
+]
```
- changedOutput schema / properties / data / properties / attributes / type
```
Previous value: -"object"New value: +[
+  "object",
+  "null"
+]
```
- removedOutput schema / properties / data / properties / relationships / properties / relationshipField / properties / label / example
```
Removed value: -"field-label"
```
- changedOutput schema / properties / data / properties / relationships / properties / relationshipField / properties / label / type
```
Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- removedOutput schema / properties / data / properties / relationships / properties / relationshipField / properties / type / properties / kind / example
```
Removed value: -"relationship"
```
- changedOutput schema / properties / data / properties / relationships / properties / relationshipField / properties / type / properties / kind / type
```
Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- removedOutput schema / properties / data / properties / relationships / properties / relationshipField / properties / type / properties / multi / example
```
Removed value: -true
```
- changedOutput schema / properties / data / properties / relationships / properties / relationshipField / properties / type / properties / multi / type
```
Previous value: -"boolean"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- removedOutput schema / properties / data / properties / relationships / properties / relationshipField / properties / type / properties / targetResourceTypes / items / example
```
Removed value: -"resource-type"
```
- changedOutput schema / properties / data / properties / relationships / properties / relationshipField / properties / type / properties / targetResourceTypes / items / type
```
Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- changedOutput schema / properties / data / properties / relationships / properties / relationshipField / properties / type / properties / targetResourceTypes / type
```
Previous value: -"array"New value: +[
+  "array",
+  "null"
+]
```
- changedOutput schema / properties / data / properties / relationships / properties / relationshipField / properties / type / type
```
Previous value: -"object"New value: +[
+  "object",
+  "null"
+]
```
- changedOutput schema / properties / data / properties / relationships / properties / relationshipField / type
```
Previous value: -"object"New value: +[
+  "object",
+  "null"
+]
```
- changedOutput schema / properties / data / properties / relationships / type
```
Previous value: -"object"New value: +[
+  "object",
+  "null"
+]
```
- changedOutput schema / properties / data / type
```
Previous value: -"object"New value: +[
+  "object",
+  "null"
+]
```
- removedOutput schema / properties / links / properties / self / example
```
Removed value: -"https://example.com/polarion/rest/v1/projects/MyProjectId/actions/getFieldsMetadata?resourceType=MyResourceType&targetType=MyTargetType"
```
- changedOutput schema / properties / links / properties / self / type
```
Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- changedOutput schema / properties / links / type
```
Previous value: -"object"New value: +[
+  "object",
+  "null"
+]
```

Changed1 schema field changedv1.2.0Sep 17, 2026

changedInput schema / properties / projectId / description

Previous value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs."

Changed1 schema field changedv1.1.0Sep 11, 2026

changedOutput schema / (root)

Previous value: -nullNew value: +{
+  "properties": {
+    "data": {
+      "properties": {
+        "attributes": {
+          "properties": {
+            "enumField": {
+              "properties": {
+                "label": {
+                  "example": "field-label",
+                  "type": "string"
+                },
+                "type": {
+                  "properties": {
+                    "enumContext": {
+                      "example": "enum-context",
+                      "type": "string"
+                    },
+                    "enumName": {
+                      "example": "enum-name",
+                      "type": "string"
+                    },
+                    "kind": {
+                      "example": "enumeration",
+                      "type": "string"
+                    }
+                  },
+                  "type": "object"
+                }
+              },
+              "type": "object"
+            },
+            "listField": {
+              "properties": {
+                "label": {
+                  "example": "field-label",
+                  "type": "string"
+                },
+                "type": {
+                  "properties": {
+                    "itemType": {
+                      "properties": {
+                        "kind": {
+                          "properties": {
+                            "enum": {
+                              "items": {
+                                "enum": [
+                                  "string",
+                                  "text",
+                                  "text/html",
+                                  "integer",
+                                  "float",
+                                  "currency",
+                                  "time",
+                                  "date",
+                                  "date-time",
+                                  "boolean",
+                                  "structure",
+                                  "relationship"
+                                ],
+                                "type": "string"
+                              },
+                              "type": "array"
+                            }
+                          },
+                          "type": "object"
+                        }
+                      },
+                      "type": "object"
+                    },
+                    "kind": {
+                      "example": "list",
+                      "type": "string"
+                    }
+                  },
+                  "type": "object"
+                }
+              },
+              "type": "object"
+            },
+            "primitiveField": {
+              "properties": {
+                "label": {
+                  "example": "field-label",
+                  "type": "string"
+                },
+                "type": {
+                  "properties": {
+                    "kind": {
+                      "properties": {
+                        "enum": {
+                          "items": {
+                            "enum": [
+                              "string",
+                              "text",
+                              "text/html",
+                              "integer",
+                              "float",
+                              "currency",
+                              "time",
+                              "date",
+                              "date-time",
+                              "boolean"
+                            ],
+                            "type": "string"
+                          },
+                          "type": "array"
+                        }
+                      },
+                      "type": "object"
+                    }
+                  },
+                  "type": "object"
+                }
+              },
+              "type": "object"
+            },
+            "structField": {
+              "properties": {
+                "label": {
+                  "example": "field-label",
+                  "type": "string"
+                },
+                "type": {
+                  "properties": {
+                    "kind": {
+                      "example": "structure",
+                      "type": "string"
+                    },
+                    "structureName": {
+                      "example": "structureId",
+                      "type": "string"
+                    }
+                  },
+                  "type": "object"
+                }
+              },
+              "type": "object"
+            }
+          },
+          "type": "object"
+        },
+        "relationships": {
+          "properties": {
+            "relationshipField": {
+              "properties": {
+                "label": {
+                  "example": "field-label",
+                  "type": "string"
+                },
+                "type": {
+                  "properties": {
+                    "kind": {
+                      "example": "relationship",
+                      "type": "string"
+                    },
+                    "multi": {
+                      "example": true,
+                      "type": "boolean"
+                    },
+                    "targetResourceTypes": {
+                      "items": {
+                        "example": "resource-type",
+                        "type": "string"
+                      },
+                      "type": "array"
+                    }
+                  },
+                  "type": "object"
+                }
+              },
+              "type": "object"
+            }
+          },
+          "type": "object"
+        }
+      },
+      "type": "object"
+    },
+    "links": {
+      "properties": {
+        "self": {
+          "example": "https://example.com/polarion/rest/v1/projects/MyProjectId/actions/getFieldsMetadata?resourceType=MyResourceType&targetType=MyTargetType",
+          "type": "string"
+        }
+      },
+      "type": "object"
+    }
+  },
+  "type": "object"
+}

AddedSep 7, 2026

TDQS

A4.5/5.0

Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already declare readOnlyHint=true and openWorldHint=true, so the safety profile is covered. The description still adds real substance beyond them — it discloses what the result contains (field ID keys, label, type kinds including list/structure/enumeration with enum name) and that custom fields for the type are included. It does not mention pagination, caching, or whether the field set is affected by permissions, which keeps it short of a 5.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Three sentences, each doing distinct work: what is returned, when to call it, and which siblings handle the adjacent cases. No filler and no repetition of the title or schema.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

An output schema exists, so the description is not obligated to detail return values, yet it still summarizes the key shape well enough to plan a call. Combined with 100% schema coverage and annotations that carry the read-only profile, an agent has everything needed to invoke this correctly.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so the schema already documents projectId (URL segment, case-sensitive, how to discover via getProjects) and response_format. The description adds no parameter-level guidance of its own, so the baseline 3 applies.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb and resource ("Returns the field definitions") scoped to "one specific Plan" and describes the return shape (keyed by field ID, label plus type kind). The Plan scoping plus the named per-instance nature clearly distinguishes it from the getFieldsMetadataForX family for other resources and from getProjectFieldsMetadata/getGlobalFieldsMetadata.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Gives an explicit trigger ("Use it before writing to the Plan to learn which field keys and value types are valid") and routes to both alternatives by name with the condition that selects each: getProjectFieldsMetadata for project-wide definitions without a concrete instance, getGlobalFieldsMetadata for global defaults.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Deploy Server