Skip to main content
Glama

Inspect Doc Structure

inspect_doc_structure
Read-onlyIdempotent

Map a Google Doc's structure to find safe insertion points, locate tables, and get precise element indices for targeted edits.

Instructions

Essential tool for finding safe insertion points and understanding document structure.

USE THIS FOR:

  • Finding the correct index for table insertion

  • Understanding document layout before making changes

  • Locating existing tables and their positions

  • Getting document statistics and complexity info

  • Inspecting structure of specific tabs

CRITICAL FOR TABLE OPERATIONS: ALWAYS call this BEFORE creating tables to get a safe insertion index.

WHAT THE OUTPUT SHOWS:

  • total_elements: Number of document elements

  • total_length: Maximum safe index for insertion

  • tables: Number of existing tables

  • table_details: Position and dimensions of each table

  • headers / footers: Real segment IDs and previews for header/footer editing

  • tabs: List of available tabs in the document (if no tab_id specified)

WORKFLOW FOR TABLE INSERTION: Step 1: Call this function Step 2: Note the "total_length" value Step 3: Use an index < total_length for table insertion Step 4: Create your table

FORMATTING WORKFLOW: After inserting all text via batch_update_doc with end_of_segment=true, call this tool with detailed=true to get exact start_index and end_index for every paragraph. Use those indices directly in format_text and update_paragraph_style operations in a second batch_update_doc call.

HEADER/FOOTER WORKFLOW: For ordinary header/footer text, use update_doc_headers_footers. If you need low-level segment editing, call this tool first and use the real segment_id values returned under headers/footers. Do not invent IDs.

The detailed output includes elements[].start_index and elements[].end_index with text_preview for each paragraph, making it easy to identify which ranges to format.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
tab_idNoOptional ID of the tab to inspect. If not provided, inspects main document.
detailedNoWhether to return detailed structure information
document_idYesID of the document to inspect
user_google_emailYesUser's Google email address

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes
Install Server

TDQS

A4.8/5.0
Behavior5/5

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

The annotations already mark this as readOnly, idempotent, and non-destructive. The description adds substantive behavioral context beyond those hints: it defines total_length as the maximum safe insertion index, warns against inventing segment IDs, and explains the conditional behavior of tabs in the output. It makes the tool's inspection semantics and safe usage bounds explicit.

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 lengthy but well-organized into labeled sections, bullets, and numbered steps, which makes the complexity navigable. It front-loads the core purpose and critical usage warning, and most sections earn their place by conveying actionable workflow detail. Some redundancy exists between the 'CRITICAL FOR TABLE OPERATIONS' callout and the repeated workflow steps, but it does not become noise.

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?

Given the tool's complexity and the presence of an output schema, the description is exceptionally complete. It covers not just what the tool returns but how to consume those outputs in real workflows (table insertion indices, formatting ranges, header/footer segment IDs). Nothing an agent needs to call this tool correctly 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?

Input schema covers 100% of parameters with descriptions, so the baseline is 3. The description adds extra meaning by explaining how the detailed parameter changes the output (elements with start_index/end_index and text_preview) and that tab_id controls whether a list of tabs is returned. This goes beyond the schema's minimal parameter descriptions.

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 clear verb+resource combination: 'inspect' + 'document structure', and goes further to state the primary purpose: finding safe insertion points and understanding layout. It differentiates itself from siblings like debug_table_structure by emphasizing safe index discovery and document-wide structure inspection, not low-level table debugging.

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?

Explicit usage guidance is provided in multiple forms: a 'USE THIS FOR' list, a 'CRITICAL FOR TABLE OPERATIONS' mandate to call before creating tables, and workflow steps for table insertion, formatting, and header/footer editing. It also names an alternative (update_doc_headers_footers) for ordinary header/footer text, drawing a clear when-to-use versus when-not-to-use boundary.

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

Other Tools

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/WorldCentralKitchen/google_workspace_mcp'

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