Skip to main content
Glama

setup_structure

Create a Diataxis-compliant documentation structure in your project. Provide root path and static site generator to generate organized documentation with optional examples.

Instructions

Create Diataxis-compliant documentation structure

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pathYesRoot path for documentation
ssgYes
includeExamplesNo
Behavior2/5

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

With no annotations, the description must disclose behavioral traits. It only states the basic action without mentioning side effects like file creation, overwriting, or required permissions. Essential details for safe usage are missing.

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

Conciseness3/5

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

The description is a single sentence and concise, but it is under-informative. Conciseness should not sacrifice clarity; here, critical details are omitted.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the lack of output schema, the description should explain what the function returns (e.g., created paths, success message). It does not, leaving the agent uninformed about the tool's full scope and effects.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters2/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is low (33%). The description does not explain the role of parameters like 'ssg' or 'includeExamples', relying solely on the schema. Since the schema itself provides limited descriptions, the tool's behavior remains ambiguous.

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 uses the verb 'Create' and specifies 'Diataxis-compliant documentation structure', which clearly identifies the tool's main function among siblings like 'populate_diataxis_content' and 'validate_diataxis_content'. However, it could more explicitly differentiate from creating content versus structure.

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?

No guidance is provided on when to use this tool versus alternatives such as 'populate_diataxis_content' or 'validate_diataxis_content'. The description lacks prerequisites or context for appropriate invocation.

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/tosin2013/documcp'

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