Skip to main content
Glama

generate_contextual_content

Analyze source code to generate context-aware documentation using AST and knowledge graph insights. Supports tutorial, how-to, reference, and explanation formats with customizable detail and output.

Instructions

Generate context-aware documentation using AST analysis and knowledge graph insights (Phase 3)

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
filePathYesPath to the source code file to document
documentationTypeNoType of Diataxis documentation to generatereference
includeExamplesNoInclude code examples in generated documentation
styleNoDocumentation detail leveldetailed
outputFormatNoOutput format for generated contentmarkdown
Behavior2/5

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

No annotations provided, so the description must disclose behavioral traits. It mentions using AST analysis and knowledge graph insights, but does not clarify if the tool modifies state, requires authorization, has performance implications, or what the output format or behavior is. Lacks necessary disclosure for a complex tool.

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?

Single sentence that conveys the core purpose. The phrase '(Phase 3)' is unnecessary and unclear, slightly reducing conciseness. Otherwise well-structured and front-loaded.

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?

No output schema, no annotations, and 5 parameters with defaults. The description does not explain return values, prerequisites (e.g., need for populated knowledge graph), or how it relates to other documentation tools. Incomplete for the complexity.

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 coverage is 100% with descriptions for all parameters. The tool description adds minimal meaning beyond the schema, such as the context-aware aspect. Baseline 3 is appropriate since the schema already describes parameter details adequately.

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?

Clearly states the verb 'Generate', the resource 'context-aware documentation', and the method 'AST analysis and knowledge graph insights'. However, it does not distinguish from sibling tools like 'populate_diataxis_content' or 'update_existing_documentation', and the mention of 'Phase 3' is ambiguous.

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 on when to use this tool versus alternatives, nor any conditions or prerequisites. The description merely states what it does without context.

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