Skip to main content
Glama

guide-registry

Get one guide's registry row

get_guide
Read-only

Get one guide's registry row by slug, with its artifact + routing-surface status.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
slugYesThe guide slug, e.g. start-a-company.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
guideYes
api_versionYes

Schema Changelog

Changes observed during successful MCP inspections. Dates show when Glama detected each change.

  1. First observed

TDQS

A4.1/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true and destructiveHint=false, so the safety profile is established. The description adds that the result includes 'artifact + routing-surface status', which is useful return-scope context, but it does not disclose behaviors like not-found handling or authentication requirements. Given the annotations, this is adequate but not exceptional.

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 a single front-loaded sentence with no filler. It states the action, scope, and return focus compactly, and every word contributes meaning.

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 single-parameter read-only tool with an output schema and read-only annotations, the description is complete. An agent has enough information to select and invoke the tool correctly without needing additional context.

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 input schema fully documents the sole parameter 'slug' with a clear example, so schema coverage is 100%. The description adds no additional parameter semantics beyond restating the lookup key. Baseline 3 is appropriate when the schema carries the parameter documentation burden.

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 clearly states the action (Get), the specific resource (one guide's registry row), and the lookup key (by slug). It distinguishes itself from list_guides by emphasizing a single guide rather than a list, and from list_capabilities/list_taxonomy by naming the guide registry scope.

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 communicates when to use this tool: when a specific guide slug is known and its registry row is needed. It does not explicitly name alternatives or exclusions, but the singular 'one guide by slug' makes the usage context obvious relative to listing siblings.

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.

Resources