Skip to main content
Glama

Create requirement

create_requirement

Create a new requirement under a specific requirement document. Provide project key, document key, and title, with an optional description to capture details.

Instructions

Create a new requirement under a requirement document.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
descNoDescription of the requirement
titleYesTitle of the requirement
projectKeyYesProject key
documentKeyYesRequirement document key to create under
Behavior3/5

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

With no annotations, the description carries the full burden. It clearly communicates the core side effect: a new requirement is created under a document. However, it does not mention prerequisites, error behavior, permissions, or the response shape.

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?

The description is a single, front-loaded sentence with no redundant filler. It states the action and the parent context efficiently.

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?

For a straightforward create tool, the description is minimally adequate, but with no output schema or annotations it leaves open questions about what the tool returns and what happens if the referenced document does not exist. It provides enough to attempt a call but not full guidance.

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 the schema already documents all parameters. The description adds no parameter-level details beyond the schema, matching the baseline.

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

Purpose5/5

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

The description states a specific action ('Create a new requirement'), a resource ('requirement'), and a parent context ('under a requirement document'). This clearly differentiates it from siblings like create_requirement_document and list_requirements.

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?

The phrase 'under a requirement document' gives clear context that this tool is for adding a requirement to an existing document, not for creating documents or projects. It does not explicitly name alternatives or exclusions, but the intended use is clear.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/Darshitpipariya/qa-touch-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server