Skip to main content
Glama
phillipboesger

Polarion MCP Server

by phillipboesger
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Hybrid

getFieldsMetadataForWorkItem

Read-only

Get field metadata for one work item to discover valid field keys and value types before writing, including custom fields configured for its type.

Instructions

Returns the field definitions that apply to one specific Work Item, 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 Work Item to learn which field keys and value types are valid. For the allowed values of one enum field, follow up with getAvailableEnumOptionsForWorkItem. 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.
workItemIdYesThe Work Item's ID within its project (e.g. `WI-123`), not the combined `project/id` path used in some link payloads.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
dataNo
linksNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields 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."
    • changedInput schema / properties / workItemId / description
      Previous value: -"The Work Item ID."New value: +"The Work Item's ID within its project (e.g. `WI-123`), not the combined `project/id` path used in some link payloads."
  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.7/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 adds behavioral context beyond annotations: it explains the return structure (keyed by field ID, with label and type kind), the inclusion of custom fields configured for the type, and the distinction between primitive/list/structure/enumeration types. It doesn't describe pagination or error behavior, but for a read-only metadata lookup with an output schema present, the description adds meaningful context without contradicting annotations.

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 sentences, each earning its place: the first defines the return value and scope, the second gives the primary use case, and the third routes to related tools. The most important information (what it returns and for which resource) is front-loaded. No filler or redundancy.

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 read-only metadata lookup with two well-documented parameters, an output schema, and annotations covering read-only/open-world behavior, the description is complete. It tells the agent what the tool returns, when to use it, and which sibling tools to use for enum values, project-wide definitions, and global defaults. Nothing an agent needs to call it correctly is missing.

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

Parameters4/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 both parameters thoroughly. The description adds value by clarifying the relationship between the parameters and the returned metadata ('one specific Work Item', 'custom fields configured for its type'), and by warning that workItemId is not the combined 'project/id' path used in some link payloads. This goes beyond the schema's own parameter descriptions, which already explain the project ID and Work Item ID formats.

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 states a specific verb ('Returns'), a specific resource ('field definitions that apply to one specific Work Item'), and the keying/contents ('keyed by field ID: each field's label and type kind...'). It clearly distinguishes itself from sibling tools like getFieldsMetadataForCollection, getFieldsMetadataForPlan, getFieldsMetadataForDocument, getFieldsMetadataForTestRun, getFieldsMetadataForTestRecord, getProjectFieldsMetadata, and getGlobalFieldsMetadata by explicitly naming the alternatives and their scopes.

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 gives explicit when-to-use guidance: 'Use it before writing to the Work Item to learn which field keys and value types are valid.' It also names follow-up and alternative tools: 'For the allowed values of one enum field, follow up with getAvailableEnumOptionsForWorkItem. For the project-wide definitions of a resource type without a concrete instance, use getProjectFieldsMetadata; for global defaults, getGlobalFieldsMetadata.' This is exemplary routing 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