get_guide
Get a full sourced setup guide (settings, commands, config files) by slug, as Markdown with source links.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| slug | Yes |
Get a full sourced setup guide (settings, commands, config files) by slug, as Markdown with source links.
| Name | Required | Description | Default |
|---|---|---|---|
| slug | Yes |
Changes observed during successful MCP inspections.
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true, so the safety profile is covered. The description usefully adds the return format (Markdown with source links) and what the guide contains, but says nothing about failure modes for an invalid slug or whether content is cached/static.
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?
A single front-loaded sentence that packs purpose, key, content scope, and output format with zero filler. Nothing to trim and nothing buried.
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, single-parameter tool with no output schema, the description covers what is fetched and in what form. The remaining gap is guidance on obtaining a valid slug and error behavior, which is minor given the tool's simplicity.
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?
With one parameter and 0% schema description coverage, the description is the only source of meaning, and it merely says lookup is 'by slug' without format, examples, or valid-value guidance. It implies the parameter's role but adds little operational detail beyond the schema's 'string' type.
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?
States a specific verb (Get) and resource (full sourced setup guide) and even enumerates the content scope (settings, commands, config files) plus the lookup key (slug) and output format (Markdown with source links). It is unambiguous on its own, though it never explicitly distinguishes itself from siblings like search_atlas or get_mcp_server.
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?
There is no when-to-use guidance, no statement of prerequisites (e.g. where a valid slug comes from), and no routing against siblings such as search_atlas. The only usage signal is the implicit 'by slug', which an agent must infer.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Add one secure layer between your agents and this server.