Skip to main content
Glama

Get a GitHub repository's architecture diagram

get_repository_diagram
Read-onlyIdempotent

Get the architecture of a public GitHub repository from GitDiagram (gitdiagram.com): a written explanation of how the codebase is organized, its main components with the source paths they live in, how those components connect, and a Mermaid flowchart of the whole system, plus a link to the interactive diagram, where every component opens its code on GitHub. Use it whenever the user wants to understand, visualize, map or explain a GitHub repository's or open-source project's architecture, structure, main modules or data flow, wants an overview before reading unfamiliar code, or asks for an architecture or system diagram of a repo. Read-only and fast: it returns the diagram GitDiagram has already made. If none exists yet, it returns a link that makes one when opened in a browser. Public repositories only. In chat apps that show interactive views, the result also appears as a zoomable diagram whose components open their code on GitHub.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
repositoryYesThe GitHub repository as "owner/repo" (e.g. "fastapi/fastapi") or any github.com URL inside it (e.g. "https://github.com/vercel/next.js/tree/canary/packages").

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4/5.0
Behavior4/5

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

Annotations already declare readOnlyHint, idempotentHint, destructiveHint=false, and openWorldHint=false, so the safety profile is covered. The description adds genuinely new behavior: it returns a pre-generated diagram rather than generating one ('fast'), returns a make-on-open link when none exists, is limited to public repos, and renders a zoomable interactive view in chat apps. It omits any auth/rate-limit context, but for a public read tool the added behavioral detail is solid.

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?

The description is front-loaded with the core purpose and return contents, then layers on usage triggers, constraints, and the interactive-view detail. It is on the long side and a couple of clauses could be trimmed, but every sentence carries substantive information.

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

Completeness5/5

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

With one required parameter, no output schema, and annotations covering the safety profile, the description fills the remaining gap by detailing what the response contains and what happens on the not-yet-generated path. An agent has everything needed to call it and interpret the result.

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 description coverage is 100% and the single 'repository' parameter's accepted formats (owner/repo or any github.com URL) are fully documented in the schema itself. The description adds no parameter-specific syntax or format guidance, so the baseline 3 applies.

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 states a specific verb and resource ('Get the architecture of a public GitHub repository from GitDiagram') and enumerates exactly what is returned: written explanation, components with source paths, connections, and a Mermaid flowchart. It is very clear what the tool does, though it never names or contrasts itself with the sibling find_repository_diagrams, so it stops short of full sibling differentiation.

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?

Usage context is stated richly: 'Use it whenever the user wants to understand, visualize, map or explain a GitHub repository's ... architecture' and 'wants an overview before reading unfamiliar code.' It also states a boundary ('Public repositories only') and a fallback path when no diagram exists. It does not, however, name an alternative tool or say when NOT to use this one versus find_repository_diagrams.

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.