Skip to main content
Glama

compile_docs

Generate agent-readable MCP artifacts from product docs: server card, llms.txt, tool schemas, examples, policy metadata, score preview, and hosted docs page.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
titleYes
metadataNo
source_urlNo
source_typeNo
openapi_specNo
website_docsNo
markdown_docsNo
policy_metadataNo
server_identifierNo
postman_collectionNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

B3.4/5.0
Behavior3/5

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

Annotations already indicate the tool is not read-only. The description adds that it generates artifacts, which aligns with the annotation. However, it does not disclose potential side effects like overwriting existing artifacts or any permissions or prerequisites, though the annotation lowers the baseline.

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 that begins with the verb and resource, then enumerates the artifact types. Every word earns its place with no unnecessary detail.

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

Completeness1/5

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

With 10 parameters, 0% schema coverage, and no output schema, this description is completely inadequate. The agent cannot determine what each parameter does, which inputs are needed for a given source type, or how the artifacts are generated from the inputs.

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

Parameters1/5

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

The schema has 0% description coverage, and the tool description does not explain any of the 10 parameters. It only vaguely references 'product docs' without mapping to fields like source_url, openapi_spec, or markdown_docs, leaving the agent without guidance on how to invoke the tool.

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 agent-readable MCP artifacts from product docs and lists specific artifact types (server card, llms.txt, tool schemas, etc.), distinguishing it from the analysis, comparison, and policy tools in the sibling list.

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?

While no explicit alternatives or exclusions are mentioned, the description provides clear context that this tool is for compiling product documentation into a specific set of artifacts. The usage is implied but unambiguous given the tool's unique purpose.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources