Skip to main content
Glama
Sign In
grp-docx-mcp

grp-docx-mcp

by Arvindh95Censof
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Python
Local

get_all_paragraphs

Retrieve all body paragraphs from a document, including index, style, text, and paraId, to identify indices for paragraph filling or paraIds after ID injection.

Instructions

Return all body paragraphs with index, style, text, and paraId. Use to discover indices for fill_paragraph_by_index or paraIds after inject_para_ids.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "get_all_paragraphs"
  }
}

Input Schema

NameRequiredDescriptionDefault
document_handleNo

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.7.4

TDQS

A4/5.0
Behavior3/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 implies a read operation by returning data but does not explicitly state that it does not modify the document. Adding a note about safety (read-only) would improve transparency.

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 two sentences, first stating the purpose and returned fields, second providing usage context. No unnecessary words, front-loaded with key information.

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?

Given that an output schema exists (not shown), the description does not need to detail return values, but it already lists fields. It mentions sibling tools for usage. However, it could clarify that it returns only body paragraphs, not headers/footers or other content.

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 0%, so the description should compensate for parameter documentation. The single parameter 'document_handle' is not described, but its name is self-evident. A brief description or clarification of its purpose would be beneficial.

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 the tool returns all body paragraphs with specific fields (index, style, text, paraId) and explicitly mentions usage for discovering indices for fill_paragraph_by_index or paraIds after inject_para_ids, distinguishing it from sibling tools.

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?

The description provides explicit context on when to use the tool: to discover indices for fill_paragraph_by_index or paraIds after inject_para_ids. It does not mention when not to use or alternatives like get_paragraph, but the provided usage context is sufficient for a read tool.

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

Deploy Server

Other Tools