Skip to main content
Glama

get_document_structure

Extract headings and paragraphs to analyze document organization and content flow in Word documents.

Instructions

Get the structure/outline of the document (headings and paragraphs)

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
docIdYesDocument identifier

Implementation Reference

  • Handler logic in the tool dispatcher function handleToolCall that invokes documentManager.getDocumentStructure for the given docId and formats the result as MCP content response.
    case "get_document_structure":
      const structure = documentManager.getDocumentStructure(args.docId);
      return {
        content: [
          {
            type: "text",
            text: `Document structure:\n${structure}`,
          },
        ],
      };
  • Tool definition including name, description, and input schema requiring 'docId' parameter.
    {
      name: "get_document_structure",
      description: "Get the structure/outline of the document (headings and paragraphs)",
      inputSchema: {
        type: "object",
        properties: {
          docId: {
            type: "string",
            description: "Document identifier",
          },
        },
        required: ["docId"],
      },
    },
  • src/index.ts:24-28 (registration)
    Registration of tool list handler that returns the documentTools array, which includes the get_document_structure tool.
    server.setRequestHandler(ListToolsRequestSchema, async () => {
      return {
        tools: documentTools,
      };
    });
  • Helper method in DocumentManager class that generates the document structure outline by extracting paragraph styles and truncated text.
    getDocumentStructure(docId: string): string {
      const docInfo = this.getDocument(docId);
      const structure: string[] = [];
    
      docInfo.paragraphs.forEach((para: any, index) => {
        const style = para.properties?.style || "Normal";
        let text = "";
    
        if (para.root && para.root.length > 0) {
          text = para.root.map((r: any) => r.text || "").join("");
        }
    
        if (text) {
          structure.push(`[${index}] ${style}: ${text.substring(0, 50)}...`);
        }
      });
    
      return structure.join("\n");
    }
Behavior2/5

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

No annotations are provided, so the description carries the full burden. It states the tool retrieves structure/outline but doesn't disclose behavioral traits like whether it's read-only (implied by 'Get' but not explicit), error handling (e.g., invalid docId), permissions needed, rate limits, or output format (e.g., JSON list). For a tool with zero annotation coverage, this is a significant gap.

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 a single, efficient sentence with zero waste. It's front-loaded with the core purpose and specifies included elements (headings and paragraphs) without unnecessary details, making it easy to parse.

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 the tool's complexity (simple read operation), lack of annotations, and no output schema, the description is incomplete. It doesn't explain what the structure/outline looks like (e.g., hierarchical list), error cases, or dependencies. For a tool with no structured output documentation, more context is needed.

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 description coverage is 100%, with the single parameter 'docId' documented as 'Document identifier'. The description adds no additional meaning beyond this, such as format examples (e.g., UUID) or constraints. Baseline 3 is appropriate when the schema does the heavy lifting.

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 clearly states the verb 'Get' and the resource 'structure/outline of the document', specifying it includes 'headings and paragraphs'. This distinguishes it from siblings like 'add_heading' or 'add_paragraph' which are write operations, but it doesn't explicitly differentiate from potential read siblings (none listed).

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

Usage Guidelines2/5

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

The description provides no guidance on when to use this tool versus alternatives. It doesn't mention prerequisites (e.g., document must exist), exclusions, or comparisons to other tools like 'find_and_replace' for content search. Usage is implied only by the tool name and purpose.

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

Install Server

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/bibash44/word-documet-mcp-server'

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