Skip to main content
Glama

Sheet index

get_sheet_index

Fetches the complete page or sheet index with one-line titles for electrical schematics or the pump manual, enabling quick navigation to specific sections.

Instructions

Complete page/sheet index of the electrical documentation (126 sheets) and the pump manual (82 pages) with one-line titles.

Input Schema

NameRequiredDescriptionDefault
doc_idNoall

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

B3.3/5.0
Behavior3/5

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

No annotations are provided, so the description carries the behavioral burden. It usefully discloses the covered documents, counts (126 sheets and 82 pages), and that entries have one-line titles, but it does not mention ordering, pagination, return shape, or that the operation is read-only/safe.

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 a single, front-loaded sentence with no filler. It communicates scope, document coverage, counts, and entry format efficiently.

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?

For a simple index tool with one optional enum parameter and no output schema, the description gives the essential contents but leaves gaps around parameter behavior (especially the default 'all') and how the index relates to page-level tools like get_page. It is adequate but not fully complete.

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 0%, and the single doc_id parameter has no schema-level explanation. The description partially compensates by naming the electrical documentation and pump manual, which map to two enum values, but it does not explain the 'all' option or that doc_id selects which index is returned.

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 resource and scope: a complete page/sheet index covering the electrical documentation and pump manual, including one-line titles. It is distinguishable from single-item siblings like get_page and find_sheet because it explicitly describes a complete index rather than one page or lookup.

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?

The description does not say when to use this tool versus alternatives such as list_drawings, find_sheet, get_page, or get_document_images. The word 'index' implies browsing, but there is no explicit usage guidance or exclusion criteria.

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