Skip to main content
Glama

scan_docx_meta_notes

Scans the first N paragraphs of a DOCX for accidentally left working notes such as TODO: or [internal], accepts custom patterns, and returns each match with its paragraph index and text.

Instructions

Scan the first N paragraphs of a DOCX for working notes left in by mistake, such as "TODO:" or "[internal]". Pass patterns to replace the defaults. Returns a list of {para_index, text, matched_pattern}.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "path": "<path>"
    },
    "name": "scan_docx_meta_notes"
  }
}

Input Schema

NameRequiredDescriptionDefault
pathYes
patternsNo
check_first_nNo

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

B3.4/5.0
Behavior3/5

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

With no annotations, the description must carry the behavior burden; it does disclose the scan scope (first N paragraphs), the default pattern set, and the returned fields. It does not state whether matching is literal or regex, whether scanning is read-only, or how unreadable/encrypted files are handled.

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?

Three short sentences, front-loaded with the core action and scope, with no filler. The return-shape sentence mildly duplicates the output schema but is harmless.

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

Completeness3/5

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

Return values are covered by the output schema and the description repeats them, so that part is complete. However, for a 3-parameter tool with zero schema description coverage, the regex/literal question and error behavior are meaningful gaps.

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 0%, so the description is the only source of parameter meaning. It usefully explains that 'patterns' replaces the built-in defaults and that check_first_n bounds the scan, but leaves the pattern syntax (regex vs literal) and 'path' constraints unstated.

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: scanning the first N paragraphs of a DOCX for accidental working notes, with concrete examples ("TODO:", "[internal]"). It is clearly distinct from generic siblings like find_docx_term, though it never names a sibling to make the boundary explicit.

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 intent (catching leftover meta-notes before sharing a document) is implied by 'left in by mistake', but there is no explicit when-to-use, when-not-to-use, or pointer to find_docx_term for general searching.

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