Skip to main content
Glama

Generate All Documentation

sdd_generate_all_docs

Generate all documentation types in parallel—full docs, API docs, runbook, onboarding guide, and SDD journey—writing them directly to the docs/ directory.

Instructions

Generates ALL documentation types in parallel: full docs, API docs, runbook, onboarding guide, and SDD journey. All documents are written to docs/ directory. This is the fastest way to generate complete project documentation.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
feature_numberYesZero-padded feature number.
spec_dirNoSpec directory..specs
Behavior3/5

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

Annotations are uninformative (all false). Description adds context: parallel generation and output to docs/ directory. However, it does not disclose idempotency, overwrite behavior, or resource usage beyond 'fastest'.

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?

Three sentences, no fluff. First sentence states core purpose and lists types, second specifies output location, third gives value proposition. Front-loaded and efficient.

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?

Provides key expectations: parallel generation, output directory, coverage of all doc types. However, lacks details on error handling, prerequisites, or whether files are overwritten. Given simplicity, still adequate.

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% with both parameters documented. The tool description adds no additional parameter information beyond the schema, so baseline score applies.

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 clearly states the tool generates 'ALL documentation types in parallel' and lists specific types: full docs, API docs, runbook, onboarding guide, and SDD journey. It distinguishes from siblings like sdd_generate_api_docs by emphasizing 'ALL' and 'parallel'.

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 use for comprehensive doc generation ('fastest way to generate complete project documentation'), but does not explicitly state when to avoid or prefer alternatives. Sibling tools for individual doc types exist without exclusion guidance.

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/paulasilvatech/specky'

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