Skip to main content
Glama
deanchong
by deanchong

get_requirement

Read-onlyIdempotent

Retrieve a specific requirement by unique identifier and return its name, description, type, and custom fields; optionally include related data in one request.

Instructions

Get a specific requirement. Retrieve a specific requirement using its unique identifier.

This endpoint returns all details of the requirement, including its name, description, type, and custom fields.

Use the relations parameter to include associated data in a single request.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pathYes
queryNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.0

TDQS

B3.3/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, idempotentHint=true, and destructiveHint=false, so the safety profile is covered. The description adds value by enumerating what the response contains (name, description, type, custom fields) and by calling out relation expansion, but it is silent on error behavior for a missing/nonexistent ID and gives no note about the openWorldHint scope.

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

Conciseness3/5

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

The first two sentences restate the same fact ('Get a specific requirement' then 'Retrieve a specific requirement using its unique identifier'), which is redundant padding. The last two sentences earn their place by describing the payload and the relations option.

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

Completeness3/5

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

With no output schema, the description partially compensates by naming the returned fields, but for a nested-path tool with relation expansion it omits key details such as what happens when the ID does not exist or is inaccessible. Adequate but with visible gaps.

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 reported as 0%, so the description must carry the load; it does identify that the lookup is by unique identifier and that 'relations' pulls in associated data. Yet it never explains the identifier format (integer ID vs. key) or which relation values are legal, so compensation is partial.

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?

The description states a specific verb and resource ('Get a specific requirement' / 'Retrieve a specific requirement using its unique identifier'), which is unambiguous against collection-style siblings like get_requirement_collection. However, it never explicitly distinguishes itself from the other requirement-scoped reads (get_requirement_tags, get_requirement_test_cases) beyond the singular/plural distinction.

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?

Usage is only implied: the identifier-based lookup context makes it clear this is the single-record read, and the last line points at the relations parameter for expanding associated data. There is no explicit when-to-use/when-not or naming of alternatives such as the collection endpoint.

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