Skip to main content
Glama

get_table

Read-only

Read a full Word table: returns every cell's text, merge map, and column widths. Use it to inspect table structure before editing, including nested tables, from the last-saved document state.

Instructions

Read one table in full: every cell's text, the merge map, and column widths. table_index is 0-based among body-level tables in document order. has_merges=false returns rows of strings; has_merges=true returns {text, grid_span, vmerge} cells. For a table nested inside a cell, pass nested={row, cell, index} addressing the host cell (index picks among several, default 0). Write with set_cells; reshape with modify_table_structure (media-forms pack). Read-only; reads the last-saved state of a document open in Word.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
nestedNo
file_pathYes
table_indexYes

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv2.0.0
    • addedInput schema / properties / nested
      Added value: +{
      +  "anyOf": [
      +    {
      +      "additionalProperties": true,
      +      "type": "object"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null
      +}
  2. First observedv1.2.1

TDQS

A4.5/5.0
Behavior4/5

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

Goes beyond the readOnlyHint annotation by adding the important 'reads the last-saved state' caveat and explaining how the output shape varies when merges are present. Error behavior is not covered, but the read-only safety profile is already annotated.

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?

Five dense sentences with no filler; the core purpose is front-loaded and every sentence adds either parameter semantics, output behavior, or routing guidance.

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

Completeness5/5

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

For a complex table-reading tool, it covers purpose, parameter semantics, nested-table handling, output variants, sibling routing, and state semantics. With an output schema present and readOnlyHint annotated, little essential information is missing.

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?

Despite 0% schema coverage, the description explains table_index's 0-based body-level indexing and nested's {row, cell, index} shape including default behavior. file_path is left implicit, but it is self-explanatory.

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 one table in full', and enumerates exactly what is returned (cell text, merge map, column widths). This clearly separates it from sibling read tools like get_text or get_outline.

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

Usage Guidelines4/5

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

Provides strong context: body-level table indexing and nested-table addressing explain when this tool applies. It also explicitly routes write and reshape operations to set_cells and modify_table_structure, though it does not contrast with other read tools.

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