get_guideGet one guide's registry row by slug, with its artifact + routing-surface status.
| Name | Required | Description | Default |
|---|---|---|---|
| slug | Yes | The guide slug, e.g. start-a-company. |
| Name | Required | Description | Default |
|---|---|---|---|
| guide | Yes | ||
| api_version | Yes |
Changes observed during successful MCP inspections. Dates show when Glama detected each change.
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true, openWorldHint=false, and destructiveHint=false, covering the safety profile. The description adds useful context by specifying that the result includes artifact and routing-surface status, which tells the agent what kind of data to expect beyond a plain registry row.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is a single, tightly written sentence that front-loads the operation and resource. Every phrase earns its place and there is no redundant filler.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a simple read-only lookup with one required parameter, an output schema, and clear annotations, the description is fully sufficient. It does not need to explain return values because the output schema already does that.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The input schema fully documents the single slug parameter with 100% coverage and an example. The description repeats 'by slug' but adds no new semantic detail beyond what the schema already provides, so the baseline of 3 is appropriate.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states a specific verb ('Get'), a precise resource ('one guide's registry row'), and the lookup mechanism ('by slug'). The singular 'one' and the mention of 'artifact + routing-surface status' clearly distinguish this from the sibling list tools.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
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: when a specific guide slug is known and a single registry row is needed. It does not explicitly say 'use list_guides when you want all guides,' so the routing guidance is somewhat implied rather than stated.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.