Skip to main content
Glama

word_session_refresh

Refresh the content-control snapshot of an open Word document to sync the latest state for further edits.

Instructions

Read-only. Ask the Office.js taskpane to refresh its open-document content-control snapshot.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
waitNo
session_idNo
timeout_secondsNo
Behavior3/5

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

The description states 'Read-only' indicating non-destructive behavior, but with no annotations, it lacks details on side effects (e.g., UI changes), session requirements, or latency. The read-only nature is disclosed, but other traits are omitted.

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 very concise and front-loaded with 'Read-only.' It achieves clarity in a single sentence, but does not waste words. However, it could be slightly more informative without losing conciseness.

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?

Despite being a simple tool, the description lacks essential context such as the need for an active session, relationship to sibling tools, and return behavior. No output schema is provided, and parameter info is missing, making it incomplete for reliable agent invocation.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters1/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The description provides no information about the three parameters (wait, session_id, timeout_seconds). With 0% schema description coverage, the description fails to compensate, leaving the agent without guidance on how to use these parameters.

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 clearly states it is a read-only operation that refreshes the open-document content-control snapshot via the Office.js taskpane. This is specific and distinguishes it from sibling tools that read, list, or modify content controls.

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

Usage Guidelines3/5

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

The description implies usage for refreshing a snapshot but does not explicitly state when to use this tool over alternatives like word_session_read_content_control or docx_list_content_controls. No exclusions or prerequisites are mentioned.

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/flyfish-dev/word-ai'

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