Skip to main content
Glama
rcarmo

office-document-mcp-server

by rcarmo

word_cleanup_sow

Destructive

Remove placeholder text, instructional content, and highlighted markers from a SOW document to produce a clean, presentation-ready version. Tracks all removals for auditability.

Instructions

Clean a SOW document by removing all placeholder and instructional content.

Removes:

  • Highlighted text (turquoise, yellow - template guidance markers)

  • Colored text (blue, red, purple - instructions)

  • Bracket placeholders that weren't filled: <...>, [Template Guidance: ...]

  • Instruction paragraphs containing guidance keywords

This is the final step after generate_sow to ensure the document is presentation-ready with no visible template artifacts. All removals are tracked for auditability.

Example: cleanup_sow( file_path="04. Artifacts/contoso-sow.docx", output_path="04. Artifacts/contoso-sow-final.docx" )

Args: file_path: Path to the SOW document to clean output_path: Path for cleaned output (defaults to overwriting input) author: Author name for tracked changes (default: "Solution Architect Agent")

Returns: Cleanup statistics

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
file_pathYesPath to the SOW document to clean
output_pathNoPath for cleaned output (defaults to overwriting input)
authorNoAuthor name for tracked changes (default: "Solution Architect Agent")
Behavior5/5

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

Annotations already mark this as destructive (destructiveHint: true), and the description reinforces that by detailing irreversible removals. It adds beyond annotations by listing specific content types removed and stating 'All removals are tracked for auditability,' which is valuable behavioral context for an agent.

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 well-structured: a one-sentence summary, a bullet list of removals, a usage context sentence, and a Python-like example with Args and Returns. It is concise yet comprehensive, with no wasted words.

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 the tool's moderate complexity and the absence of an output schema, the description covers inputs, behavior, and return value (cleanup statistics). It could be slightly more specific about what 'cleanup statistics' includes, but overall it provides sufficient context for correct invocation.

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?

The input schema already provides clear descriptions for all three parameters (file_path, output_path, author), covering 100% of the schema. The description adds extra value by noting the default behavior for output_path ('defaults to overwriting input') and the author default, plus an example call with real paths.

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 starts with a specific verb ('Clean') and resource ('SOW document'), clearly distinguishing it from sibling tools like word_generate_sow or word_parse_sow_template. It lists exactly what is removed (e.g., highlighted text, bracket placeholders), making the tool's purpose unmistakable.

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?

Explicitly states 'This is the final step after generate_sow to ensure the document is presentation-ready with no visible template artifacts.' This tells the agent exactly when to use it and implies not to use it before generation. The example with file paths further clarifies typical usage.

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/rcarmo/python-office-mcp-server'

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