Skip to main content
Glama

get_oscal_documentation

Retrieves exact OSCAL documentation line ranges by docId when search snippets lack detail; use start line and has-more to continue reading.

Instructions

Read an OSCAL documentation page by docId as a verbatim line range. Use when a query_oscal_documentation snippet is not enough. A response may hold fewer lines to fit the response budget; continue from end-line + 1 while has-more is true.

Input Schema

NameRequiredDescriptionDefault
doc_idYesdocId from a query_oscal_documentation result.
line_countNoMaximum lines to return, 1-500.
start_lineNo1-based first line to return.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv0.7.1

TDQS

A4.4/5.0
Behavior4/5

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

With no annotations, the description carries the disclosure burden and does well: it warns that the response may return fewer lines than requested to fit the response budget and explains the continuation protocol (`end-line` + 1 while `has-more` is true). It does not cover failure behavior for an unknown docId or state that the operation is non-mutating, so it stops short of full transparency.

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?

Three short sentences, zero filler, and the identifying purpose plus the disambiguating alternative come first, with pagination handling last. Every sentence earns its place.

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

Completeness4/5

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

For a three-parameter read tool with no output schema, the description covers purpose, selection, and the pagination envelope fields (`end-line`, `has-more`) the agent must not see in structured output. It stops just short of complete by not mentioning invalid-docId handling or how to know the document's total length.

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 coverage is 100%, so doc_id, start_line, and line_count are already documented in the schema; the description adds the continuation semantics around the returned range rather than new meaning for the inputs. Baseline 3 applies when the schema does the parameter work.

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

Purpose5/5

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

States a specific verb and resource ("Read an OSCAL documentation page by docId as a verbatim line range") and immediately differentiates itself from the sibling query_oscal_documentation, which returns snippets. An agent can choose between the two without opening either schema.

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

Usage Guidelines5/5

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

Gives an explicit trigger condition ("Use when a query_oscal_documentation snippet is not enough") and names the alternative that covers the other case. Nothing about selection is left to inference.

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