Skip to main content
Glama
Inflectra Spira MCP Server

Inflectra Spira MCP Server

Official
by Inflectra

template_get_metadata

Read-only

Retrieve metadata sections for a Spira product template, optionally filtered by metadata or artifact type, to inspect statuses, priorities, custom properties, and related configuration.

Instructions

Retrieves template metadata sections for a product template.

template_id: numeric ID (e.g. 45 for PT:45). metadata_type: sections to fetch (see enum). Omit for all. artifact_type: filter to one kind (e.g. "Requirement"). Omit for all. Some sections are artifact-specific (e.g. severities→Incident, importances→Requirement). Returns JSON: {template_id, sections, warnings}.

Input Schema

NameRequiredDescriptionDefault
template_idYes
artifact_typeNo
metadata_typeNo

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed9 schema fields changedv2.1.0
    • removedInput schema / properties / artifact_type / anyOf
      Removed value: -[
      -  {
      -    "type": "string"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]
    • removedInput schema / properties / artifact_type / title
      Removed value: -"Artifact Type"
    • addedInput schema / properties / artifact_type / type
      Added value: +"string"
    • removedInput schema / properties / metadata_type / anyOf
      Removed value: -[
      -  {
      -    "items": {
      -      "enum": [
      -        "types",
      -        "custom_properties",
      -        "statuses",
      -        "priorities",
      -        "severities",
      -        "importances",
      -        "probabilities",
      -        "impacts"
      -      ],
      -      "type": "string"
      -    },
      -    "type": "array"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]
    • addedInput schema / properties / metadata_type / items
      Added value: +{
      +  "enum": [
      +    "types",
      +    "custom_properties",
      +    "statuses",
      +    "priorities",
      +    "severities",
      +    "importances",
      +    "probabilities",
      +    "impacts"
      +  ],
      +  "type": "string"
      +}
    • removedInput schema / properties / metadata_type / title
      Removed value: -"Metadata Type"
    • addedInput schema / properties / metadata_type / type
      Added value: +"array"
    • removedInput schema / properties / template_id / title
      Removed value: -"Template Id"
    • removedInput schema / title
      Removed value: -"template_get_metadataArguments"
  2. First observedv1.1.1

TDQS

A3.7/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, destructiveHint=false, openWorldHint=true, so the safety profile is covered. The description adds that omitted filters return everything and that some sections only apply to certain artifact types — genuinely useful behavioral context. It says nothing about error handling, permissions, or response size, so it is a middling score rather than a high one.

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?

One lead sentence followed by a tight per-parameter list and a one-line return shape. Front-loaded with purpose, no filler, and every line carries information an agent needs.

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?

An output schema exists, so the brief 'Returns JSON: {template_id, sections, warnings}' line is slightly redundant but harmless confirmation. For a read-only, three-parameter retrieval tool the description covers purpose, scoping, and return shape adequately; the only real omission is how to choose between this and get_artifact_schema.

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 0%, so the description must carry the load, and it does: it documents all three parameters, including the ID format ('45 for PT:45'), the default-to-all behavior for both optional filters, and an example artifact_type value. It defers enum values to the schema ('see enum') rather than enumerating the eight metadata types, which keeps it from a 5.

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+resource: 'Retrieves template metadata sections for a product template.' An agent can tell this is a metadata-reading tool rather than an artifact search/update tool, which covers most siblings. It does not explicitly contrast with the closest sibling, get_artifact_schema, so it falls short of a 5.

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

Usage Guidelines3/5

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

The parameter notes ('Omit for all', 'filter to one kind', 'severities→Incident, importances→Requirement') give practical guidance on how to scope a call, which is implied usage context. However there is no explicit statement of when to use this versus get_artifact_schema or the search tools, and no exclusions or prerequisites.

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