Skip to main content
Glama

getProjectFieldsMetadata

Read-only

Retrieves field metadata for a resource type and optional target subtype within a single Polarion project, requiring a project ID to scope the request.

Instructions

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.

Input Schema

NameRequiredDescriptionDefault
projectIdYesThe 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.
targetTypeNoThe 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.
resourceTypeYesThe Resource Type.
response_formatNoResponse 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

NameRequiredDescriptionDefault
dataNo
linksNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv1.4.4
    • 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."
  2. Changed2 schema fields changedv1.4.0
    • 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"
      +}
    • changedInput schema / properties / targetType / description
      Previous value: -"Identifies the target resource type this operation applies to (e.g. `workitem`). Use `~` (no quotes) to mean no specific target type."New value: +"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."
  3. Changed54 schema fields changedv1.3.1
    • 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"
      +]
  4. 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 / targetType / description
      Previous value: -"The Type of the object. Use '~' without quotes to represent no target Type."New value: +"Identifies the target resource type this operation applies to (e.g. `workitem`). Use `~` (no quotes) to mean no specific target type."
  5. 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"
      +}
  6. Added

TDQS

A3.8/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true and openWorldHint=true, so safety is covered and the output schema covers the return shape. The description contributes the project-scoping constraint but says nothing about what the returned field definitions include or how the resource/target type pair affects results.

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 short sentences with the scope constraint front-loaded and the alternative named last; there is no filler or repetition.

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

Completeness4/5

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

With annotations, a full-coverage schema, and an output schema present, the description covers what an agent needs to invoke this correctly. The remaining gap is disambiguation from the numerous per-resource-type metadata siblings in the same server.

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 all four parameters are documented in the schema, including the '~' wildcard convention and the concise/detailed modes. The description only echoes the resource-type/target-type pairing, adding no syntax or semantics beyond what the schema already provides.

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

Purpose4/5

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

States a specific verb and resource (returns fields metadata) and constrains it to the Project context, which separates it from getGlobalFieldsMetadata. However, it does not distinguish itself from the many sibling getFieldsMetadataForWorkItem/Document/Plan/TestRun tools, so an agent must infer how resourceType selects among them.

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

Usage Guidelines4/5

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

Explicitly names the alternative and the condition that selects it ('to act across all projects, use getGlobalFieldsMetadata'), plus the requirement of a project ID. Missing is guidance on when to prefer this over the per-artifact metadata siblings, which is the more likely confusion.

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