Skip to main content
Glama

Get ONES Document Chunks

get_doc_chunks
Read-onlyIdempotent

Fetch one cursor-based chunk from a ONES document using a character budget to support paginated reading.

Instructions

Return one cursor-based chunk from a ONES doc ref using a character budget.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
refYes
cursorNo
max_charsNo
include_resourcesNo

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
docYes
chunkYes
has_moreYes
markdownYes
next_cursorYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed4 schema fields changedv2.1.0
    • removedInput schema / properties / cursor / anyOf
      Removed value: -[
      -  {
      -    "type": "string"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]
    • addedInput schema / properties / cursor / type
      Added value: +[
      +  "string",
      +  "null"
      +]
    • removedOutput schema / properties / next_cursor / anyOf
      Removed value: -[
      -  {
      -    "type": "string"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]
    • addedOutput schema / properties / next_cursor / type
      Added value: +[
      +  "string",
      +  "null"
      +]
  2. Changed3 schema fields changedv2.0.0
    • removedOutput schema / properties / content
      Removed value: -{
      -  "additionalProperties": false,
      -  "properties": {
      -    "children": {
      -      "items": {},
      -      "type": "array"
      -    },
      -    "resources": {
      -      "items": {},
      -      "type": "array"
      -    },
      -    "source_format": {
      -      "enum": [
      -        "html",
      -        "richtext-json",
      -        "plain"
      -      ],
      -      "type": "string"
      -    },
      -    "type": {
      -      "const": "document",
      -      "type": "string"
      -    }
      -  },
      -  "required": [
      -    "type",
      -    "source_format",
      -    "children"
      -  ],
      -  "type": "object"
      -}
    • addedOutput schema / properties / markdown
      Added value: +{
      +  "type": "string"
      +}
    • changedOutput schema / required
      Previous value: -[
      -  "doc",
      -  "chunk",
      -  "content",
      -  "has_more",
      -  "next_cursor"
      -]New value: +[
      +  "doc",
      +  "chunk",
      +  "markdown",
      +  "has_more",
      +  "next_cursor"
      +]
  3. First observedv1.4.0

TDQS

B3.1/5.0
Behavior3/5

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

Annotations cover read-only, idempotent, non-destructive behavior. The description adds that results are chunked and cursor-driven with a character budget, which is useful context, but does not clarify how cursors advance or how to retrieve the entire document.

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

Conciseness4/5

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

The description is a single short sentence that is front-loaded and efficient. However, it is arguably too concise for a tool with four parameters and no schema descriptions.

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?

Given four parameters with 0% coverage and an underlying paginated/chunked operation, the description omits essential details about how to call the tool, how `ref` is initially obtained, how to paginate, or what the output schema returns. It is incomplete for correct invocation.

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 0%, so the description must explain `ref`, `cursor`, `max_chars`, and `include_resources`. It only vaguely references a 'character budget', without naming parameters or clarifying their roles and constraints. This leaves most parameter semantics unclear.

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 specifies a clear verb ('Return') and resource ('one cursor-based chunk from a ONES doc ref'), which distinguishes it from document-level siblings like get_doc and get_doc_outline. It could be sharper about being a paginated read of document content, but the core purpose is identifiable.

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?

The cursor-based, chunked nature implies when to use it (streaming large docs), but no explicit when/when-not guidance or alternatives (e.g., 'use get_doc for the full document') are given. There are many doc-related siblings it could be compared against.

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