get_knowledge_article
Read a public guide by its exact catalog ID.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes |
Read a public guide by its exact catalog ID.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes |
Changes observed during successful MCP inspections.
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already flag readOnlyHint, idempotentHint, and destructiveHint=false. The description adds value beyond these by noting the guide is 'public,' indicating access/auth expectations, and 'exact catalog ID,' which clarifies that the tool's matching is exact rather than fuzzy. No contradiction with annotations.
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, well-structured sentence starting with the action verb 'Read', immediately identifying the resource ('a public guide') and the scoping mechanism ('by its exact catalog ID'). No filler or redundant clauses.
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?
Given that this is a single-parameter, read-only, idempotent tool with strong annotations, the description is essentially complete. It tells the agent what to provide and what operation will be performed, though it does not detail the return value or the not-found case; the word 'Read' supplies enough for a simple GET-style tool.
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 schema provides a string pattern and maxLength but no semantic description (0% coverage). The description compensates by labeling the parameter as a 'catalog ID' and emphasizing it must be 'exact', which tells the agent the kind of value to supply and how it will be matched. This is meaningful beyond the schema constraints.
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 clearly states the verb 'Read', the resource 'a public guide', and the specific requirement 'by its exact catalog ID'. This differentiates it from search_knowledge (which searches, not fetches by exact ID) and get_business_info (which retrieves business info), so the agent can distinguish without opening schemas.
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 the tool should be used when the exact catalog ID is known, but it does not explicitly call out the alternative for unknown IDs (e.g., search_knowledge). The usage context is clear from the phrase 'exact catalog ID,' but there is no direct 'use this when...' or 'use search_knowledge instead...' guidance.
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.