Skip to main content
Glama

octri_get_doc_page

Fetches a single API documentation page by its slug. Optionally specify a project; defaults to the CLI's selected project.

Instructions

One documentation page by slug.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
slugYes
project_idNoProject id. Optional, falls back to the CLI's selected project.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.4

TDQS

C2.4/5.0
Behavior2/5

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

No annotations are provided, so the description carries the full behavioral burden, and it discloses almost nothing. It does not say whether authentication is required, what happens when the slug does not exist, whether the project falls back to a default, or what the returned page contains.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness3/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is a single short fragment with no wasted words and is trivially front-loaded, but it is terse to the point of under-specification rather than efficient communication.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a tool with no annotations, no output schema, and an undocumented required parameter, the description should explain the lookup key, error behavior, and return shape. It supplies none of these, leaving the agent with substantial gaps before invoking it.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters2/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is only 50%: project_id is documented in the schema but slug has no schema description, and the description only restates 'by slug' without adding format, casing, or resolution semantics. It does not compensate for the undocumented slug parameter.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose3/5

Does the description clearly state what the tool does and how it differs from similar tools?

The phrase 'One documentation page by slug' identifies the resource (a documentation page) and the lookup key (slug), which implicitly distinguishes it from the sibling octri_list_doc_pages. However, it is a sentence fragment with no verb and no explicit differentiation from the list tool, so the agent must infer that this returns a single page.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

There is no statement of when to use this tool versus octri_list_doc_pages or any other sibling, and no prerequisites or exclusions are given. Usage is only implied by the singular 'One documentation page'.

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