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.3/5.0
Behavior4/5

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

Annotations already cover readOnlyHint=true and destructiveHint=false, and the description adds behavioral context about the returned row including 'artifact + routing-surface status'. For a simple getter with a safe read profile, this is sufficient behavioral disclosure.

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?

A single front-loaded sentence that states the action, resource, lookup key, and result contents without any wasted words. It earns its place entirely.

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?

Given the tool's simple complexity (one fully documented required parameter), the presence of an output schema, and annotations covering the safety profile, the description is complete enough for an agent to call it correctly. Nothing critical 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?

Schema description coverage is 100% and the schema already documents the slug parameter with an example. The description restates the 'by slug' lookup but adds no new semantic detail beyond what the schema provides, which matches the baseline for full 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 ('Get'), a precise resource ('one guide's registry row'), and the lookup key ('by slug'). It adds what the result includes ('artifact + routing-surface status'), which distinguishes it from list_guides and other siblings that return full collections.

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 the tool: when you need a single guide registry row identified by slug, as opposed to listing multiple guides. It provides clear context (single vs. list) but does not explicitly name alternatives or state when-not-to-use conditions.

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