Skip to main content
Glama

Get requirement

get-requirement
Read-only

Get a specific requirement by its key (e.g. 'AUTH-1') with all its children (Given/When/Then/And nodes).

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
projectYesThe project target: its slug (find it with list-projects), e.g. 'acme-checkout'
requirementKeyYesThe requirement key (e.g., "AUTH-1", "REQ-123")

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.8/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true, so the safety profile is covered. The description adds real value beyond that by disclosing the return shape: the requirement plus all children as Given/When/Then/And nodes, which matters since there is no output schema.

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 sentence, front-loaded with the action and the identifier, with the return detail appended. Nothing is wasted and nothing is ambiguous.

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?

For a two-parameter read tool with no output schema, the description covers what is returned (children nodes) and how to identify the target. It could still note behavior when the key is not found, but it is otherwise sufficient to call the tool correctly.

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 both parameters are already documented, including the pointer to list-projects for the slug. The description's 'e.g. AUTH-1' merely echoes the schema's example, adding no new meaning. Baseline 3 applies when the schema does the heavy lifting.

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 ('Get a specific requirement by its key') and adds the key-format example ('AUTH-1'), so the agent knows this is a point lookup rather than a list. It does not name the sibling it competes with (list-requirements, search-requirements), so the differentiation is inferred rather than stated.

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 requirement for a known key is implied by 'by its key', which suggests use only when the caller already has an identifier. However, no explicit when-to-use vs. search-requirements/list-requirements guidance or prerequisites (e.g. project slug needed) appear in the description.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources