Skip to main content
Glama

extract_document_data

Read-onlyIdempotent

Extract metadata, text, or structure from Word, Excel, or PowerPoint files to access content without modifying the original document.

Instructions

Read data from a document: metadata (author/title/etc.), text (plain text plus a block count), or structure (paragraphs/sheets/slides). Read-only — never modifies the input file. To compare two documents, use compare_documents.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
modeNoWhat to extract: metadata, text, or structure.metadata
optionsNoTool options.
input_pathYesPath to the source document.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections. Dates show when Glama detected each change.

  1. Changed4 schema fields changed
    • addedInput schema / $defs / ToolOptions / properties / action
      Added value: +{
      +  "anyOf": [
      +    {
      +      "enum": [
      +        "compare",
      +        "snapshot",
      +        "list_snapshots",
      +        "restore"
      +      ],
      +      "type": "string"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null,
      +  "description": "Sub-operation for compare_documents: \"compare\" (default) diffs two documents; \"snapshot\" records path_a state; \"list_snapshots\" lists recorded snapshots; \"restore\" writes a snapshot back to path_b.",
      +  "title": "Action"
      +}
    • addedInput schema / $defs / ToolOptions / properties / snapshot_dir
      Added value: +{
      +  "anyOf": [
      +    {
      +      "type": "string"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null,
      +  "description": "Directory to store/read document snapshots (default: ~/.tianshang-scribe/snapshots/).",
      +  "title": "Snapshot Dir"
      +}
    • addedInput schema / $defs / ToolOptions / properties / snapshot_id
      Added value: +{
      +  "anyOf": [
      +    {
      +      "type": "string"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null,
      +  "description": "Snapshot identifier used by the restore action.",
      +  "title": "Snapshot Id"
      +}
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "additionalProperties": true,
      +  "title": "extract_document_dataDictOutput",
      +  "type": "object"
      +}
  2. First observedv0.3.0

TDQS

A4.4/5.0
Behavior3/5

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

The description restates the read-only and non-destructive behavior that the annotations already provide (`readOnlyHint: true`, `destructiveHint: false`, `idempotentHint: true`), so it adds little new behavioral disclosure. The mode-specific output hints (e.g., "plain text plus a block count") offer minor added context, but no deeper risks, auth needs, or side effects are described.

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 three short clauses, front-loaded with the core action, and every sentence earns its place. It conveys purpose, read-only safety, and a sibling alternative with no wasted words.

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?

Given the presence of an output schema and strong annotations, the description is largely complete: it states what the tool extracts, confirms it is non-destructive, and offers a comparison alternative. The only notable gap is the confusing `options` parameter, which is not addressed, but the schema's 100% coverage mitigates this.

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

Parameters4/5

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

The schema already covers all parameters with 100% description coverage, so the baseline is 3. The description adds useful meaning to the `mode` parameter by giving examples (author/title, paragraphs/sheets/slides). However, it does not clarify the `options` parameter, whose schema references compare_documents-specific actions, so the description doesn't fully disambiguate all parameters.

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?

The description uses a specific verb and resource: "Read data from a document," and enumerates the three extraction modes (metadata, text, structure) with concrete examples. It also distinguishes itself from the sibling `compare_documents` tool by saying "To compare two documents, use compare_documents."

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?

It clearly states when to use the tool: when you need to read metadata, text, or structure. It gives an explicit alternative for a different use case (comparison), and the read-only declaration makes it clear this is not for editing or modifying documents.

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

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/Tianshang301/TianshangScribe'

If you have feedback or need assistance with the MCP directory API, please join our Discord server