Skip to main content
Glama

Search requirements

search-requirements
Read-only

Search a project's requirements by text or regex. Searches requirement keys, content, and labels.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
queryYesText or regex pattern to search for
projectYesThe project target: its slug (find it with list-projects), e.g. 'acme-checkout'
useRegexNoIf true, treat query as a regular expression (default: false)

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

B3.4/5.0
Behavior3/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 genuinely useful behavioral scope by naming the searched fields (requirement keys, content, labels), but says nothing about filtering behavior, result caps, or pagination, which matters for a search tool.

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?

Two short sentences with zero filler; the search mode is front-loaded and the field scope follows immediately. Nothing could be cut without losing information.

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 should ideally hint at what a search returns (matching requirements, ordering, result limits), and it does not. It is adequate for invocation but leaves the agent unsure what to expect back or how to page through large result sets.

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 baseline is 3, but the description goes beyond the schema: the schema only says the query is a 'text or regex pattern', while the description clarifies which requirement fields that pattern is matched against (keys, content, labels). That is real added meaning for interpreting the query parameter.

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 names a specific verb (Search) and resource (a project's requirements) and narrows the search mode to text or regex, so the purpose is unambiguous. It does not, however, distinguish itself from close siblings like list-requirements or get-requirement, leaving the agent to infer which retrieval tool fits.

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

Usage Guidelines2/5

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

There is no explicit when-to-use guidance: nothing says whether this replaces list-requirements when a text query is available, or when get-requirement is preferred for a known key. The usage is only weakly implied by the words 'by text or regex', and no exclusions or prerequisites are given.

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