Skip to main content
Glama
Sign In
Engineering Documentation MCP Server

Engineering Documentation MCP Server

by mfaizanmumtaz
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Python
Local

generate_architecture

Generate architecture documentation for a repository, producing a system flowchart and ER diagram in Mermaid syntax.

Instructions

Generate architecture documentation including Mermaid diagrams for a repository. Returns system architecture flowchart and ER diagram in Mermaid syntax.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "repo_path": "<repo_path>"
    },
    "name": "generate_architecture"
  }
}

Input Schema

NameRequiredDescriptionDefault
repo_pathYesPath to the repository.

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

B3.3/5.0
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 states that the tool returns Mermaid syntax diagrams, but it does not clarify whether it reads from the repository only, writes files, or has side effects. The word 'Generate' could imply writing, though 'Returns' suggests a pure return value.

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 two concise sentences, front-loaded with the core action and immediately specifying the output format. Every word earns its place with no redundancy.

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

Completeness3/5

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

The description covers the tool's purpose and output, and an output schema exists. However, it lacks usage context, operational limitations, and guidance on how this tool fits among siblings. Given the moderate complexity of generating architecture diagrams, this is adequate but has clear gaps.

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% for the single repo_path parameter, and the description merely refers to 'repository' without adding additional meaning beyond what the schema already provides. This meets the baseline for high schema coverage.

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 uses a specific verb ('Generate') and resource ('architecture documentation for a repository'), and clearly defines the output ('system architecture flowchart and ER diagram in Mermaid syntax'). This distinguishes it from sibling tools like generate_project_documentation, which likely produces broader documentation.

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?

The description gives no guidance on when to use this tool versus alternatives such as analyze_repository or generate_project_documentation. There is no mention of prerequisites, exclusions, or preferred use cases.

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

Deploy Server

Other Tools