Skip to main content
Glama
phillipboesger

Polarion MCP Server

by phillipboesger
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Hybrid

getFieldsMetadataForCollection

Read-only

Retrieve field definitions for a specific Polarion collection to identify valid field keys, labels, and value types before writing data.

Instructions

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 to the Collection 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

TableJSON Schema
NameRequiredDescriptionDefault
projectIdYesThe 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.
collectionIdYesThe Collection ID.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
dataNo
linksNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv1.2.0
    • 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."
  2. Changed1 schema field changedv1.1.0
    • 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"
+}
  3. Added

TDQS

A4.5/5.0
Behavior4/5

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

Annotations already provide readOnlyHint and openWorldHint, so the safety profile is covered. The description adds meaningful behavioral context beyond annotations: the output is keyed by field ID, it details the type taxonomy, and it includes custom fields. It does not mention errors, auth, or rate limits, but for a read-only metadata getter these are minor omissions.

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?

The description is three tight sentences: the first states what it returns, the second states when to use it, and the third routes to alternatives. There is no filler, and the most important information is front-loaded.

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?

For a two-parameter, read-only metadata getter with an output schema and explicit sibling routing, the description is complete. An agent knows what the tool returns, why it should be called, and which related tools to choose instead. The remaining absences around error behavior are not essential for correct invocation.

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%, and the schema already explains projectId as a case-sensitive Polarion URL segment with a pointer to getProjects. The description does not need to repeat parameter meanings; collectionId remains terse as 'The Collection ID,' but since the schema covers both parameters, a baseline score of 3 is appropriate.

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?

The description opens with a specific verb and resource: 'Returns the field definitions that apply to one specific Collection.' It also describes the returned content in useful detail (field ID keys, labels, type kinds, enumeration names, custom fields), and it explicitly distinguishes this tool from getProjectFieldsMetadata and getGlobalFieldsMetadata, making sibling selection easy.

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?

The description explicitly states when to use the tool: 'Use it before writing to the Collection to learn which field keys and value types are valid.' It also names alternatives for other scopes: project-wide definitions via getProjectFieldsMetadata and global defaults via getGlobalFieldsMetadata, giving clear when-to-use and when-not-to-use guidance.

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

Deploy Server

Other Tools