Skip to main content
Glama

Learn the spec-loop method

learn
Read-onlyIdempotent

Return one spec-loop method topic—artifacts, feedback, fields, glossary, index, loop, phases, project, questioning, or use-cases—to guide feature specification.

Instructions

Return one topic of the spec-loop method; phases and fields are generated from the schema. Topics: artifacts, feedback, fields, glossary, index, loop, phases, project, questioning, use-cases.

Input Schema

NameRequiredDescriptionDefault
topicNoDefaults to index

Output Schema

NameRequiredDescriptionDefault
topicYes
topicsYes
contentYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A3.5/5.0
Behavior3/5

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

Annotations already declare readOnlyHint, idempotentHint, destructiveHint=false, and openWorldHint=false, so the safety profile is covered. The description adds that topics are generated from the schema, but it does not add much behavioral context beyond what annotations and the output schema provide.

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 short and front-loaded, stating the core behavior before listing topics. The topic list is somewhat redundant with the enum, but it remains useful and does not bloat the definition.

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 one-parameter read-only tool with an output schema and rich annotations, the description is mostly complete. It explains what is returned and lists valid topics; the output schema handles return structure, so no major gaps remain.

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 the topic parameter is fully enumerated with a default documented in the schema. The description repeats the topic list but does not add meaning beyond the schema, so the baseline of 3 is appropriate.

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: it returns one topic of the spec-loop method, and it enumerates the available topics. The purpose is clear, but it does not differentiate itself from siblings such as phase, features, or status.

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 description implies usage as a documentation/topic lookup by saying it returns one topic and listing valid topics. However, it does not state when to choose this tool over siblings like phase or features, nor does it provide any exclusions or prerequisites.

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