Find in the document
document_findParagraphs containing the text (case-insensitive), with snippets around the match.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| query | Yes |
document_findParagraphs containing the text (case-insensitive), with snippets around the match.
| Name | Required | Description | Default |
|---|---|---|---|
| query | Yes |
Changes observed during successful MCP inspections.
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
There are no annotations, so the description carries the behavioral burden. It discloses case-insensitive matching, that only paragraphs containing the text are returned, and that snippets are included. It doesn't mention match limits or no-match behavior, but for a simple find operation this is adequate.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
One sentence, front-loaded with the result shape and key matching behavior. No filler or redundancy.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a one-parameter search tool with no output schema, the description captures the search term, case sensitivity, and return shape. It lacks only usage guidance and boundary behavior, which are minor for this simple tool.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
With 0% schema description coverage, the description provides the needed semantic: the query parameter is the text to match, and matching is case-insensitive. This is sufficient for a single string parameter already constrained by min/max length in the schema.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states exactly what the tool produces: paragraphs containing the search text. Its document/paragraph framing also distinguishes it from sibling sheet_find and broader document_read.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Use is implied: call this when you need to locate text within a document and see surrounding snippets. It does not explicitly state when to prefer document_read or sheet_find, nor list exclusions.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Add one secure layer between your agents and this server.