Skip to main content
Glama

Find similar documents

find_similar_documents
Read-onlyIdempotent

Find documents whose file content is identical to a given document (by file hash), for spotting duplicates.

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": {
      "documentId": "<documentId>"
    },
    "name": "find_similar_documents"
  }
}

Input Schema

NameRequiredDescriptionDefault
documentIdYesDocument id

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A4/5.0
Behavior4/5

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

The annotations already declare read-only, idempotent, non-destructive, closed-world behavior, so the description's remaining job is small. It contributes real value by stating that matching is exact content identity via file hash, which disambiguates the misleading word 'similar' in the tool name.

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?

One sentence, front-loaded with the operation and the exact matching criterion, with no filler. Every clause earns its place.

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?

For a one-parameter read tool with full annotation coverage this is nearly complete. The only gap is that no output schema exists and the description does not say what comes back (ids, metadata, or empty results when no duplicates exist).

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 100% for the single documentId parameter, so the schema already documents the input and a baseline of 3 applies. The description only implies that the id is resolved to a content hash; it adds syntax, format, or failure behavior for the parameter.

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 gives a specific verb and resource plus a precise matching rule: documents whose file content is identical, matched by file hash. This clearly separates it from siblings like find_documents and search_library, which imply retrieval by name or text rather than exact byte-identical content.

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?

'For spotting duplicates' implies the use case, so an agent can infer when to reach for this tool. However, it names no alternative and states no exclusion such as 'use search_library for text matching'; the distinction is left to be inferred.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources