Skip to main content
Glama

Create requirement document

create_requirement_document

Create a requirement document within a project release by specifying the project key, release key, and document title.

Instructions

Create a new requirement document in a project under a release.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
titleYesTitle of the requirement document
projectKeyYesProject key
releaseKeyYesRelease (milestone) key to create the document under
Behavior2/5

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

No annotations are present, so the description carries the full burden of behavioral disclosure. It only states the creation action and does not mention side effects, required parent existence, idempotency, permissions, or what the response contains. 'Create' implies mutation, but little else is revealed.

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

Conciseness4/5

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

The description is a single concise sentence with no filler, and the core action is front-loaded. It is efficient, though it omits useful context that could have been included without much extra length.

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 simple three-parameter create tool, the schema and description together provide enough information to invoke it with the required fields. However, with no annotations and no output schema, the description leaves return behavior, prerequisites, and sibling-tool relationships unspecified, making it only minimally complete.

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%, and each parameter is already documented in the schema. The description adds no parameter-level meaning beyond what the schema provides, so it meets the baseline but does not exceed it.

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 ('Create') and resource ('new requirement document') plus the scoping context ('in a project under a release'), so the primary purpose is clear. It does not explicitly differentiate from the sibling create_requirement, but the word 'document' provides some distinction.

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 guidance on when to use this tool versus alternatives like create_requirement or create_release. The intended context is implied by the description, but no explicit when-to-use, exclusions, or alternative routing is provided.

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