Skip to main content
Glama

read_file

Read-onlyIdempotent

Retrieve a vault-relative Markdown file as stored. Useful after search or when the path is known, without writing changes.

Instructions

Read one vault-relative Markdown file exactly as stored. Use after search or when the path is known; does not write files or sidecar state.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pathYesVault-relative Markdown path to read, such as notes/project.md.
Behavior4/5

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

Annotations already declare readOnlyHint=true, destructiveHint=false, and idempotentHint=true. The description adds context that the file is read "exactly as stored" and clarifies it does not write sidecar state, which aligns with annotations and adds small but useful behavioral detail.

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 extremely concise with two sentences totaling 17 words. It front-loads the core purpose in the first sentence and adds contextual usage in the second. No unnecessary words.

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?

Given the tool's simplicity (one parameter, no output schema, strong annotations), the description covers all necessary aspects: purpose, when to use, behavioral constraints, and what it does not do. It is complete for an AI agent to select and invoke correctly.

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 coverage is 100%, so baseline is 3. The description does not add any additional meaning beyond the schema's parameter description ("vault-relative Markdown path"). No extra context about format or constraints is provided.

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 clearly states the verb "Read" and resource "one vault-relative Markdown file exactly as stored." It distinguishes from siblings by specifying "Use after search or when the path is known," making its purpose 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 explicitly tells when to use this tool ("after search or when the path is known") and what it does not do ("does not write files or sidecar state"). However, it does not name specific alternative tools like scan_vault or get_stats, just implies the context.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/Semiotronika/LINZA-MCP'

If you have feedback or need assistance with the MCP directory API, please join our Discord server