Skip to main content
Glama

gid_read

Read a graph-based software architecture and return its structure or summary in YAML, JSON, or plain summary format.

Instructions

Read and return the current graph structure or summary

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
formatNoOutput format (default: summary)
graphPathNoPath to graph.yml (optional)
Behavior3/5

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

With no annotations, the description carries the burden for behavioral disclosure. 'Read and return' implies a safe read operation, but it does not explicitly state nondestructiveness, error conditions, or other traits. The description is minimal but sufficient for a simple read 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?

The description is a single sentence with no wasted words. It is concise, though not structured with bullet points or sections, but it earns its place.

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?

Given the absence of annotations and output schema, and only two parameters, the description is minimal. It does not explain return values or behavior beyond reading. For a read tool this is adequate but not comprehensive, especially among many siblings.

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% (both parameters documented in schema). The description adds no additional meaning beyond the schema's existing documentation, so a baseline score of 3 is appropriate.

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 specifies the verb 'Read and return' and the resource 'current graph structure or summary', clearly indicating the tool's purpose. It distinguishes from siblings like gid_edit_graph (modification) and gid_analyze (analysis).

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. The description implies it's for reading, but there is no explicit context, exclusion criteria, or mention of related siblings.

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/potatouniverse/graph-indexed-development-mcp'

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