Skip to main content
Glama

infosys_get_page

Read-only

A documentation page as Markdown (headings, tables, fenced code), read from the local Help Viewer package — any page in it, indexed or not; doc version + breadcrumb included.

Instructions

A documentation page as Markdown (headings, tables, fenced code), read from the local Help Viewer package — any page in it, indexed or not; doc version + breadcrumb included. ref: full Infosys URL, 'book/pageid', a bare page id, or a symbol name ('ADSREAD'). Offline. Use max_chars to keep it short.

Input Schema

NameRequiredDescriptionDefault
refYes
offsetNoskipped first: the next page is offset=<next_offset>
refreshNo
sectionNo
max_charsNocharacters shown, 200-60000; read on with section= or offset=

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed5 schema fields changedv0.8.18
    • addedInput schema / properties / max_chars / description
      Added value: +"characters shown, 200-60000; read on with section= or offset="
    • addedInput schema / properties / max_chars / maximum
      Added value: +60000
    • addedInput schema / properties / max_chars / minimum
      Added value: +200
    • addedInput schema / properties / offset
      Added value: +{
      +  "default": 0,
      +  "description": "skipped first: the next page is offset=<next_offset>",
      +  "minimum": 0,
      +  "title": "Offset",
      +  "type": "integer"
      +}
    • addedInput schema / properties / section
      Added value: +{
      +  "anyOf": [
      +    {
      +      "type": "string"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null,
      +  "title": "Section"
      +}
  2. First observedv0.6.0

TDQS

A3.7/5.0
Behavior4/5

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

Annotations already declare this as a safe read-only operation, and the description adds meaningful context: offline access, Markdown output structure, inclusion of doc version and breadcrumb, and coverage of unindexed pages. It does not fully explain pagination or truncation behavior beyond mentioning max_chars.

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

Conciseness5/5

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

The description is compact and front-loaded, naming the resource and output format first, then ref formats and practical limits. Every sentence and fragment carries useful information without repetition.

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

Completeness3/5

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

The presence of an output schema and read-only annotations reduces the burden, and the description covers the core ref and max_chars behavior. Still, for a five-parameter tool with 40% schema coverage, the omission of section, refresh, and offset semantics leaves important invocation details incomplete.

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

Parameters3/5

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

Schema description coverage is only 40%, and the description compensates partially by explaining accepted ref formats and the purpose of max_chars. However, it leaves offset, refresh, and section unexplained, so an agent must infer their behavior from sparse schema text.

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

Purpose4/5

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

The description states a specific verb and resource: retrieving a documentation page as Markdown from the local Help Viewer package. It adds useful scope detail (any page, indexed or not; version and breadcrumb included) but does not explicitly differentiate itself from sibling tools such as infosys_search or infosys_declaration.

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

Usage Guidelines3/5

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

Usage is implied through accepted ref formats and the offline nature of the tool, but there is no explicit guidance on when to choose this over infosys_search or how to use search first to discover a ref. The max_chars note is parameter guidance rather than a when-to-use rule.

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

Deploy Server

Other Tools