Skip to main content
Glama
Sign In
docs-search-mcp

docs-search-mcp

by yassineldieb2-hrd
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Python
Hybrid

read_note

Read-onlyIdempotent

Fetch the content of a single note using its relative path from list_notes or search_notes.

Instructions

Read one note by its relative path as returned by list_notes / search_notes.

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": "read_note"
  }
}

Input Schema

NameRequiredDescriptionDefault
pathYes
max_charsNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A3.9/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, idempotentHint=true and destructiveHint=false, so the safety profile is fully covered without description help. The description adds no behavioral context of its own — nothing about truncation via max_chars, missing-path errors, or what the note content looks like — so it neither helps nor contradicts.

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?

A single front-loaded sentence with no filler; the core action and its input contract are stated immediately.

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?

There is no output schema, so the description is the only place to explain the return value (note content, truncation behavior, format), and it does not. For a simple two-parameter read tool this is survivable but leaves an agent guessing about truncation and error cases.

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 0%, so the description must compensate, and it only partly does: it clarifies that 'path' is relative and produced by sibling tools, but says nothing about 'max_chars' or what happens when the note exceeds it. One of two parameters is meaningfully explained.

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?

States a specific verb (read) and a precisely scoped resource (one note), which immediately separates it from list_notes and search_notes that operate on collections. The addition of the relative-path provenance makes the operation unambiguous.

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

Usage Guidelines4/5

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

The description tells the agent where the required path comes from (list_notes / search_notes), which is the key usage dependency. It stops short of naming when not to use it (e.g., fetch_url for external content) or stating prerequisites, so it is clear context without exclusions.

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