get_public_guide
Read /v1/public-api/guide verbatim; does not grant tenant API access.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |
Read /v1/public-api/guide verbatim; does not grant tenant API access.
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
| Name | Required | Description | Default |
|---|---|---|---|
| result | 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, idempotentHint=true, destructiveHint=false, and openWorldHint=false. The description adds useful behavioral context beyond those annotations: it returns the guide "verbatim" and explicitly does not grant tenant API access, which helps an agent understand the scope and output nature.
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 compact sentence with the core action and scope limitation front-loaded. Every clause adds useful information, and there is no redundant wording.
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?
With zero parameters, full schema coverage, annotations covering safety traits, and an output schema available, the description supplies the key missing context: verbatim reading and no tenant API access. It is nearly complete for this simple read tool, though it could briefly state what the guide contains.
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 tool has zero parameters, so there is no parameter semantics burden. The description does not need to explain inputs, and the baseline for a parameterless tool is appropriately met.
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 ("Read") and resource ("/v1/public-api/guide"), and clarifies that it does not grant tenant API access. It is clear enough to distinguish this public-guide read from tenant-scoped API operations, though the resource is identified only by path rather than plain-language content.
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 phrase "does not grant tenant API access" implies a boundary: use this for the public guide, not for tenant API access. However, it does not explicitly say when to use this tool versus alternatives or what prerequisites exist, so the guidance is only implied.
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.