Skip to main content
Glama

vault_query

Read-onlyIdempotent

Retrieve content from a vault project by specifying the project slug, section shortcut, or file path. Use instead of direct filesystem access.

Instructions

Read content from a vault project — use instead of direct filesystem access.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
projectYesProject slug (directory under 10_projects/), or '_meta' for 00_meta/.
sectionNoShortcut name (context, tasks, roadmap, lessons). Ignored if path is set.context
pathNoRelative path to a specific .md file within the project. Overrides section. (Use `path` for a file, not `identifier` — `identifier` is accepted as an alias.)
max_linesNoMaximum lines to return. 0 = unlimited.
include_metadataNoPrepend a structured metadata line from YAML frontmatter.
identifierNoAlias of `path` (#151). Prefer `path`; for a section shortcut use `section` instead.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes
Behavior3/5

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

Annotations already declare readOnlyHint and idempotentHint, so the description's 'Read content' aligns. No additional behavioral details beyond what annotations provide, which is acceptable for a safe read operation.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

A single concise sentence that front-loads the purpose. Could be slightly expanded for completeness but is efficient and clear.

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?

Given the tool has 6 parameters, annotations, and an output schema, the description is minimal. It doesn't mention return format or error handling, but for a straightforward read tool this is adequate but not comprehensive.

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 100%, so the schema already documents each parameter's meaning. The description text does not add extra parameter context, but the baseline score of 3 is appropriate.

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 'Read content from a vault project', specifying a verb (read) and resource (vault project). It also distinguishes from file system access and implicitly from siblings like vault_write and vault_search.

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?

Explicitly says 'use instead of direct filesystem access', providing context for when to use. Does not explicitly list when not to use or compare to vault_list/search, but the sibling names and purpose make alternatives clear.

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/mlorentedev/hive'

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