Skip to main content
Glama
WilliamSmithEdward

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

Read a module from the editor

xlide_live_read_module
Read-onlyIdempotent

Read a VBA module's live source from the running editor, including unsaved edits, to see what the user is actually working on.

Instructions

Reads a module's text as the running editor holds it, including edits the user has not saved. This is the one read that can differ from xlide_read_module, and the difference is exactly the user's unsaved work. Use it to see what they are actually working on; use xlide_read_module for what is in the file. surface_only=true reads the modern editor's own copy instead, which exists only for a module the user has open in a tab. start_line and end_line read a slice of long live source; content_token describes the whole live module.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pidNoWhich session, by process id.
projectNoWhich project, when two documents are open and both hold a module of this name.
end_lineNoLast source line. 0 means the end.
start_lineNoFirst source line. 0 means the start.
module_nameYesModule name as the editor shows it.
surface_onlyNoRead the modern editor's own copy, which only exists for an open tab. Off reads the module through the editor, which always answers.

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 / end_line
      Added value: +{
      +  "default": 0,
      +  "description": "Last source line. 0 means the end.",
      +  "minimum": 0,
      +  "title": "End Line",
      +  "type": "integer"
      +}
    • addedInput schema / properties / start_line
      Added value: +{
      +  "default": 0,
      +  "description": "First source line. 0 means the start.",
      +  "minimum": 0,
      +  "title": "Start Line",
      +  "type": "integer"
      +}
  2. First observedv0.1.0

TDQS

A4.5/5.0
Behavior5/5

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

Beyond the read-only/idempotent annotations, it discloses that this read includes unsaved edits, can differ from the file read, and that surface_only=true reads the editor's own copy only for an open tab. It also explains slice behavior via start_line/end_line.

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 front-loaded with the core purpose and sibling comparison, then adds conditional details. It is mostly efficient, though the content_token sentence is not tied to an input parameter and slightly dilutes focus.

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

Completeness4/5

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

It is complete enough for a live read tool with annotations and an output schema covering return values. The main remaining gap is that pid and project are left entirely to the schema, though their schema descriptions are already clear.

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%, so the schema already documents all six parameters. The description adds some meaning for start_line/end_line and surface_only, but much of that overlaps with schema descriptions, and its content_token mention does not map to an input parameter.

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 states a specific verb and resource: reading a module's text as the running editor holds it, including unsaved edits. It explicitly distinguishes this tool from xlide_read_module by explaining the exact difference is the user's unsaved work.

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?

It gives explicit when-to-use guidance: use this to see what the user is actually working on, and use xlide_read_module for what is in the file. It also clarifies the surface_only condition and when that alternate read exists.

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