Skip to main content
Glama

read-batch

Perform batch reads of notes, extracting specific headings, sections, or generated summaries from Obsidian vaults.

Instructions

Unified tool for reading batches of notes, specific headings, sections, or generated summaries

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
actionYesAction to perform: 'read', 'get-section', 'get-headings', 'get-summary'
pathsNoComma-separated list or JSON array of paths
include_frontmatterNoInclude frontmatter in output (default true)
pathNoPath to the note
headingNoHeading to extract
linesNoNumber of preview lines (default 5)
Behavior3/5

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

With no annotations, the description should disclose side effects or limitations. It lists actions but does not mention if operations are read-only, permissions needed, or rate limits. Adequate but could be more transparent.

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?

Single sentence that is concise and front-loaded with the purpose. However, it could be structured with a bullet list of actions for better readability.

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

Completeness2/5

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

With 6 parameters and no output schema, the description is too vague. It does not clarify which parameters are needed for each action or the output format, leaving the agent to infer.

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 parameters are well-described in the schema. The description adds context about batch reading but does not explain how actions relate to parameters.

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?

Description clearly states it's a unified tool for reading batches of notes, specific headings, sections, or summaries, distinguishing it from sibling tools like 'search-vault' or 'manage-notes'.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

No guidance on when to use this tool vs alternatives. It calls itself 'unified' but does not explain scenarios where other tools might be better.

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/zach-snell/obx'

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