Read a Colyseus documentation page

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

No annotations provided, so description carries full burden. Describes output format: pre-processed Markdown with JSX stripped but code blocks and prose preserved. Implicitly indicates read-only operation. Does not disclose all possible behaviors (e.g., error handling, rate limits), but sufficient for scope.

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?

Three sentences with no fluff. First sentence states purpose, second gives guidance, third explains output. Efficiently front-loads key information.

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?

No output schema, so description compensates by explaining return format. Provides usage guidance and sibling tool reference. Could mention error cases or page existence handling, but overall complete for a simple read tool with one parameter.

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?

Single parameter 'slug' has schema description already, but tool description adds valuable examples and notes that empty string or 'index' returns landing page. Schema coverage is 100%, and description enhances understanding beyond schema.

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?

Description clearly states verb and resource: 'Read a single Colyseus documentation page by its slug'. Examples of slugs are given. Distinguishes from sibling tools by referencing list_docs for discovery.

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?

Explicitly advises to use list_docs first to discover available slugs. Provides context on when to use this tool (reading a specific page) versus listing all pages. Lacks explicit when-not-to-use or alternative guidance, but adequate given sibling context.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.