markdown-vault-mcp

by agustinvalencia

Overview Schema Source Related Servers Discussions Admin

Python

Local

read_note

Retrieve note content from a markdown vault by specifying a path, with an optional line limit to shorten the output.

Instructions

Read a note from the vault.

Args: note_path: Path to the note relative to vault root max_lines: Optional maximum number of lines to return. If omitted, returns the full note.

Returns: Note content (possibly truncated) or error description

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_path": "<note_path>"
    },
    "name": "read_note"
  }
}

Input Schema

Name	Required	Description	Default
`max_lines`	No
`note_path`	Yes

Output Schema

Name	Required	Description	Default
`result`	Yes

Schema Changelog

Changes observed during successful MCP inspections.

First observedv0.3.1Sep 6, 2026

TDQS

A4.4/5.0

Behavior4/5

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

With no annotations provided, the description carries the behavioral burden. It states that the note content is returned, that max_lines may truncate output, and that omitting max_lines returns the full note. 'Read' also clearly implies a non-mutating operation, which is sufficient for a simple read tool.

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?

The description is concise and well-structured with a one-line purpose followed by Args and Returns sections. Every sentence adds information about invocation or behavior, with no filler or redundant content.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a two-parameter read operation with an output schema, the description is complete: it defines the purpose, both parameters, truncation behavior, and error return. Nothing critical is missing for an agent to correctly select and invoke this tool.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters5/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The input schema has 0% description coverage, but the description fully compensates. It explains note_path as relative to the vault root and describes max_lines as optional with explicit default behavior. This gives the agent everything needed to set both parameters correctly.

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 opens with 'Read a note from the vault,' which names a specific verb, resource, and domain. It clearly differentiates content retrieval from sibling operations like get_metadata, search_notes, or append_to_note.

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 use case is implied: use this tool when you need a note's actual content, rather than metadata or search results. However, the description does not explicitly state when to prefer read_note over alternatives like get_metadata or search_notes, nor does it give any exclusion criteria.

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