Skip to main content
Glama
Sign In
File AI

File AI

by flyfish-dev
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Local

Search document content

doc_search

Search document blocks to retrieve excerpts with stable anchors for precise citation.

Instructions

Search document blocks and return excerpts tied to stable anchors.

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": {
      "query": "<query>"
    },
    "name": "doc_search"
  }
}

Input Schema

NameRequiredDescriptionDefault
indexIdNo
pathNo
queryYes
limitNo
contextCharsNo
caseSensitiveNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

C2.9/5.0
Behavior3/5

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

No annotations provided, so description carries full burden. It discloses that it returns excerpts but does not mention read-only nature, auth needs, or details like case sensitivity or anchor mechanics.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness3/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Single sentence, front-loaded with verb and resource, but lacks parameter descriptions. Could be expanded without becoming verbose.

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?

With 6 parameters, 0% schema description coverage, no output schema, and no annotations, the description does not provide sufficient context for correct invocation. Agent needs more detail on constructing queries and interpreting anchors.

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?

Schema description coverage is 0%, and description provides no explanation for any of the 6 parameters (indexId, path, query, limit, contextChars, caseSensitive). Agent must rely on schema alone.

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?

Description uses specific verb 'Search' and resource 'document blocks', and mentions returning 'excerpts tied to stable anchors', which clearly distinguishes from siblings like doc_read (full document) or doc_analyze (analysis).

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

Usage Guidelines2/5

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

No explicit guidance on when to use vs alternatives (e.g., doc_read for full retrieval, doc_context for contextual info). Does not mention prerequisites or when not to use.

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