Skip to main content
Glama

topology_status

Check topology index health: indexer state, file counts, nodes, edges, DB size, last sync, languages, and errors. Clear message if indexing is disabled.

Instructions

Report the health and statistics of the topology index for this workspace: indexer state, indexed/skipped file counts, total nodes and edges, database size, last sync time, indexed languages, and the most recent indexing error if any. Returns a clear message when topology indexing is disabled.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
workspaceNoAbsolute path to the workspace root. Defaults to the session workspace.
Behavior4/5

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

With no annotations, the description carries the full burden. It discloses the tool's output components and the special behavior when indexing is disabled. It does not explicitly state read-only status, but the nature of a status report makes this implicit, and the edge case handling adds transparency.

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 sentences long, front-loaded with the primary purpose, and lists specific metrics without any filler. Every phrase adds value, earning a perfect score.

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?

For a simple status tool with one optional parameter and no output schema, the description is comprehensive: it lists all reported data points and explicitly describes the disabled-indexing response. The workspace parameter is documented in the schema, so no information is missing.

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?

The schema has one optional parameter 'workspace' with a full description, achieving 100% schema coverage. The tool description adds no additional parameter-level detail, so the baseline score of 3 applies.

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 ('Report') and clearly identifies the resource ('topology index') and scope ('for this workspace'). It lists concrete metrics (indexer state, file counts, nodes, edges, etc.), distinguishing it from sibling tools like topology_search and topology_explore.

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?

The description clearly implies when to use this tool: whenever the agent needs health or statistics about the topology index. It does not explicitly mention when not to use it or name alternatives, which prevents a perfect score.

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/plumbkit/plumb'

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