Get Portal Page

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

Annotations already provide readOnlyHint=true, so the read-only safety is covered. The description adds useful behavioral constraints beyond the annotation: only the latest published version is accessible and project context must be set beforehand.

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?

Four short sentences, each carrying distinct information: what the tool returns, scoping constraints, how to discover slugs, and the required precondition. No filler or restatement of the schema.

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 two-parameter read tool with a high-coverage schema and a readOnly annotation, the description is complete: it names the return content, scopes the accessible pages, gives the discovery path, and states the prerequisite.

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%, so the baseline is 3. The description adds meaningful value by tying documentationId to the latest published version and by telling the agent to use search_portal_docs to discover valid pageSlug values.

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 opens with a specific verb-resource statement: 'Retrieve a single PUBLISHED documentation page by slug, with its full Markdown content.' The qualifiers 'single', 'PUBLISHED', 'by slug', and 'latest published version' clearly separate it from discovery tools like search_portal_docs and from revision-oriented tools.

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?

It explicitly tells the agent to use search_portal_docs to discover slugs and requires set_context first. It clearly states the call context but does not explicitly name when-not-to-use alternatives for other version/unpublished scenarios.

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