Skip to main content
Glama
Sign In
fastmcp-notes

fastmcp-notes

by ketcx
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Python
Local

read_note

Retrieve a specific note by its unique ID from the knowledge base. Get the full note content and details instantly by providing the note's ID.

Instructions

Read a note by ID. Demonstrates ctx.read_resource().

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": {
      "note_id": "<note_id>"
    },
    "name": "read_note"
  }
}

Input Schema

NameRequiredDescriptionDefault
note_idYes

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

B3.3/5.0
Behavior3/5

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

With no annotations provided, the description carries the burden of behavior disclosure. It clearly indicates a read-only operation and references ctx.read_resource(), but it does not describe error handling, not-found behavior, or whether any side effects occur.

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?

The description is short and front-loaded with the essential action. However, the second sentence 'Demonstrates ctx.read_resource()' is meta-context that does not help an agent select or invoke the tool correctly, so not every sentence earns its place.

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?

For a simple single-parameter read tool with an output schema, the description is minimally adequate. It is missing guidance on when to use this tool versus search_notes and what happens when the note_id does not exist, leaving notable gaps for an agent operating without richer context.

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. 'By ID' adds meaning by mapping note_id to the note identifier, but it provides no additional detail about the ID format or where it comes from beyond the property name.

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?

The description clearly states the verb 'Read' and the resource 'a note by ID', which is specific enough for an agent to understand the core operation. It is naturally distinct from the sibling tools create_note, search_notes, and delete_note, though it does not explicitly name these alternatives.

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 phrase 'Read a note by ID' implies this tool should be used when the agent already has a note_id and wants the note's content. However, it does not explicitly say when to prefer this over search_notes or what to do when the ID is unknown.

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