Skip to main content
Glama

get_document_xml_structure

Retrieve the XML structure of an InDesign document, including tags and elements, to analyze or export the document's XML content.

Instructions

Get XML structure of the document

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
includeTagsNoInclude XML tags
includeElementsNoInclude XML elements
Behavior2/5

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

With no annotations provided, the description carries full responsibility for disclosing behavioral traits. It only says 'Get XML structure', implying a read operation, but does not state whether it modifies state, requires specific permissions, or what format the structure is returned in.

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

Conciseness3/5

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

The description is a single sentence, which is concise, but it adds little beyond the tool's name. It is not overly verbose, but it does not earn its place by providing valuable additional information.

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 has only two boolean parameters with defaults and no output schema, the description should still clarify what the XML structure entails and what the return format looks like. It does not, leaving gaps in understanding. Sibling tools like export_document_xml highlight the need for differentiation, which is absent.

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 coverage is 100%, with both parameters having clear names and descriptions (includeTags, includeElements with defaults). The description adds no extra meaning beyond what the schema already provides, so a baseline score of 3 is appropriate.

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 action 'Get' and the resource 'XML structure of the document', which is specific enough to convey the tool's purpose. However, it does not distinguish this tool from related siblings like export_document_xml or get_document_elements, which also involve XML or document structure.

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?

No guidance is provided on when to use this tool versus alternatives such as export_document_xml or place_xml_on_page. The description lacks any context about appropriate use cases or prerequisites.

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/zachshallbetter/indesign-mcp-server'

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