Skip to main content
Glama

mcp-docs

Generate documentation for your codebase using TypeDoc. Specify a directory to document specific projects or use the current directory by default.

Instructions

Execute mcp-docs: npx typedoc

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
directoryNoDirectory to run the command in (optional, defaults to current directory)
Behavior2/5

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

No annotations are provided, so the description carries the full burden of behavioral disclosure. It only states the command to execute ('npx typedoc'), without detailing traits like whether it modifies files, requires internet access, has side effects, or handles errors. For a tool with zero annotation coverage, this leaves significant gaps in understanding its behavior and safety.

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 extremely concise with just one sentence ('Execute mcp-docs: npx typedoc'), which is front-loaded and wastes no words. Every part earns its place by directly stating the action, making it efficient and easy to parse, though this brevity contributes to gaps in other dimensions.

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 complexity of executing a documentation tool with no annotations and no output schema, the description is incomplete. It doesn't explain what 'npx typedoc' does, what outputs to expect, or any dependencies. For a tool that likely generates documentation, more context is needed to understand its role and results, making it inadequate for effective use.

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

Parameters4/5

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

The description adds no parameter information beyond what the input schema provides, but schema description coverage is 100%, documenting the single optional 'directory' parameter clearly. With only one parameter and high schema coverage, the baseline is strong, and the description doesn't need to compensate. However, it doesn't add extra meaning, such as examples or constraints, keeping it at a baseline level.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose3/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description states the tool executes 'npx typedoc', which implies generating documentation, but it's vague about what 'mcp-docs' specifically does beyond that command. It doesn't distinguish from sibling tools like mcp-formatter or mcp-linter, which likely handle different code-related tasks. The purpose is understandable but lacks specificity about the resource or outcome (e.g., TypeScript documentation generation).

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. It doesn't mention context, prerequisites, or exclusions, such as whether it requires TypeScript files or specific project setups. With siblings like mcp-testgen and mcp-translator, there's no indication of how this tool fits into a workflow or when it's preferred over others.

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/caroline-davis/mcp-basics'

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