Skip to main content
Glama
WilliamSmithEdward

xlide-excel-word-powerpoint-access-office-vba-mcp

Read form design

xlide_read_form
Read-onlyIdempotent

Inspects one Office form's saved design, returning each control's name, type, containing section, and explicitly set properties; supports paging through large forms.

Instructions

Reads one form's design: every control with its name, type, the container it sits in, and the properties the developer set. Properties left at their default are not stored and so are not listed. A property read failure appears as _read_error, not an empty property set; unreadable sections have sections_error. Use offset and next_offset to read large forms in pages. Use it to understand a form's layout, or to see which control an event procedure belongs to.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
offsetNoSkip this many controls before a page.
file_pathYesAbsolute path to the Office file.
form_nameYesForm name, matched without case.
max_controlsNoReturn at most this many controls.
include_propertiesNoInclude each control's set properties. Off gives just the tree.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changedv1.2.2
    • addedInput schema / properties / max_controls
      Added value: +{
      +  "default": 300,
      +  "description": "Return at most this many controls.",
      +  "maximum": 300,
      +  "minimum": 1,
      +  "title": "Max Controls",
      +  "type": "integer"
      +}
    • addedInput schema / properties / offset
      Added value: +{
      +  "default": 0,
      +  "description": "Skip this many controls before a page.",
      +  "minimum": 0,
      +  "title": "Offset",
      +  "type": "integer"
      +}
  2. First observedv0.1.0

TDQS

A4.4/5.0
Behavior5/5

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

Adds substantial behavioral detail beyond annotations: default properties are omitted, property read failures surface as _read_error rather than empty sets, unreadable sections expose sections_error, and large forms are paged with offset/next_offset. This meaningfully informs the agent about edge cases and return behavior.

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?

Front-loaded with the core purpose, then behavior and usage details follow in tight, information-dense sentences. Every sentence earns its place without redundant restatement.

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 read-only annotations and an existing output schema, the description covers what the agent needs: scope, error markers, pagination, default property omission, and practical use cases. No critical gaps remain.

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?

Schema coverage is 100%, so the baseline is 3, but the description adds useful context for offset/next_offset pagination and clarifies why some properties may not appear, which supports interpretation of include_properties and control listings.

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?

States a specific verb and resource: 'Reads one form's design.' The focus on a single form and its controls is clear, but the description does not explicitly name or contrast with siblings such as xlide_list_forms or xlide_edit_form.

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?

Gives clear usage contexts: 'Use it to understand a form's layout, or to see which control an event procedure belongs to.' It also explains pagination via offset and next_offset, but offers no explicit when-not guidance or named alternatives.

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