Machine documentation
get_docsThe whole machine guide as JSON: quickstart, what each verdict means, packs, the rules every check runs, and every public route.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
get_docsThe whole machine guide as JSON: quickstart, what each verdict means, packs, the rules every check runs, and every public route.
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
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, and destructiveHint=false, so the safety profile is fully covered. Because there is no output schema, the description's enumeration of the returned JSON sections (quickstart, verdict meanings, packs, check rules, routes) is the only place the payload shape is disclosed, which is genuine added value; it could go further by warning that the full guide is a large single payload.
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?
One front-loaded sentence with a colon list that carries all the content information; zero filler and no repetition of the title or annotations.
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 no parameters and no output schema, the description carries the payload description responsibility and does it adequately. The one residual gap is that the agent is not told the response is a large full-guide dump with no filtering option, which matters for context budgeting.
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 takes zero parameters, so the schema has nothing to document and the baseline of 4 applies. Nothing in the description is needed to clarify parameter usage.
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 resource (the whole machine guide) and an explicit scope ('whole'), then enumerates the sections returned: quickstart, verdict meanings, packs, check rules, public routes. That is enough for an agent to know exactly what it gets, though it never explicitly contrasts itself with get_pricing, get_service_status, or lookup_site.
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?
Usage is only implied: an agent can infer it should call this to learn verdict semantics, pack behavior, and available routes, since those are named as contents. There is no explicit when-to-use statement, no ordering relative to siblings, and no exclusions.
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.