Read a complete Markdown note, returning its content with parsed frontmatter. Accepts a vault-relative path and supports .md files only.
Read a complete Markdown note with parsed frontmatter.
Only .md is supported. Use search_vault for PDF or Canvas content.
| Name | Required | Description | Default |
|---|---|---|---|
| path | Yes | vault-relative path, such as 'folder/note.md' |
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |
Changes observed during successful MCP inspections.
v0.1.0Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The description clearly indicates a read-only operation on a note, with no side effects mentioned. Since annotations are absent, this description carries the full burden and adequately discloses the tool's behavior.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is two sentences, with the primary function stated first and the limitation/alternative second. It is concise, well-structured, and every word adds value.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given that the tool has an output schema (as per context signals), the description need not explain return values. It provides sufficient context about the operation, supported file type, and alternative for other types, making it complete.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The only parameter 'path' is described as a vault-relative path with an example, and the description adds that only .md is supported, clarifying the expected input format. The schema coverage is 100%.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description explicitly states the tool reads a complete Markdown note with parsed frontmatter, making the purpose unambiguous. It also distinguishes from search_vault for other content types, clarifying its scope.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
It clearly specifies that only .md files are supported and directs users to search_vault for PDF or Canvas content, providing explicit when-to-use and when-not-to-use guidance.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.