get_docs
Get the full agent-readable guide for one product by slug (overview, features, setup, usage).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| slug | Yes | Product slug, e.g. 'projscan'. |
Get the full agent-readable guide for one product by slug (overview, features, setup, usage).
| Name | Required | Description | Default |
|---|---|---|---|
| slug | Yes | Product slug, e.g. 'projscan'. |
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?
No annotations are present, so the description carries the full burden. It states the output (a full guide) but does not disclose error behavior, read-only nature, or format details. For a simple read operation, this is acceptable but not rich.
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 one sentence of 14 words, front-loaded with the verb and resource. Every word contributes meaning, and there is no redundancy or fluff.
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 tool with one parameter and no output schema, the description is fairly complete. It explains what the guide contains and that it is selected by slug. Slight improvement could be made by indicating where the slug comes from, but that is not essential for the tool's use.
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?
Schema coverage is 100% with a clear description of the 'slug' parameter. The description's mention of 'by slug' reinforces the schema but adds no additional semantic value beyond what the schema already provides.
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 uses a specific verb 'Get' and clearly identifies the resource: 'full agent-readable guide for one product by slug'. It also lists content types (overview, features, setup, usage), making it distinct from sibling tools like list_products, get_install, and get_mcp_config, which serve different purposes.
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 implies usage when a product slug is known and the full guide is needed. However, it does not explicitly state when to prefer this over sibling tools or how to obtain the slug, leaving the guidance implicit rather than explicit.
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.
Each tool has a clearly distinct purpose: find_tools searches by goal, list_products enumerates the catalogue, and get_docs/get_install/get_mcp_config retrieve different specific details for a product. No two tools overlap in intent or output, so an agent can accurately select the right one.
All tool names follow a consistent verb_noun pattern: find_tools, list_products, get_docs, get_install, get_mcp_config. The use of lowercase snake_case with clear verbs (find, list, get) creates a predictable and uniform naming convention.
Five tools is well-suited for a read-only catalogue server: one discovery search, one list operation, and three detail views (docs, install, config). This is neither too thin nor too heavy, and every tool serves a distinct informational purpose.
The catalogue domain is fully covered: users can explore all products (list_products), search by intent (find_tools), and retrieve each product's documentation (get_docs), installation command (get_install), and MCP configuration (get_mcp_config). There are no obvious missing operations for a non-mutable catalogue.