Skip to main content
Glama
Synexiom-Labs

nodiom-mcp

Read Markdown section

nodiom_read

Extract any Markdown section, heading, or list item by structural selector. Read precise content from files without regex or string manipulation.

Instructions

Returns the Markdown content at a structural location in a file. Use a selector like "# Heading > ## Subheading" to address any section. Use "# H1 > ## H2 > li[0]" to read a specific list item. Returns the raw Markdown string of the matched content.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
fileYesAbsolute path to the Markdown file.
selectorYesStructural selector. Examples: "# Project > ## Tasks", "## Notes > p[0]", "## Tasks > li[-1]"

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4/5.0
Behavior4/5

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

With no annotations, the description carries the burden. It discloses that the tool returns the raw Markdown string of the matched content and explains the selector addressing scheme. It does not discuss error behavior when no content is matched, but for a read operation the return type and non-destructive nature are reasonably transparent.

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?

Three sentences with no fluff. The core behavior and output are stated first, followed by two concise selector examples. Every sentence carries useful information, and nothing is redundant with the schema.

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

Completeness4/5

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

For a low-complexity tool with two required parameters and no output schema, the description covers the main inputs and the return type. It does not mention edge cases like missing files or unmatched selectors, but the provided examples and clear return description are sufficient for an agent to call this tool correctly in typical cases.

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 baseline is 3. The description reinforces the selector semantics with additional examples and explains that it can address sections and specific list items, but this largely duplicates examples already present in the schema. It adds some conceptual clarity but does not compensate for a schema gap because there is none.

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 a specific verb and resource: 'Returns the Markdown content at a structural location in a file.' It also names the exact output ('raw Markdown string') and gives concrete selector syntax examples, which distinguishes it from sibling tools like nodiom_write, nodiom_delete, and nodiom_tree.

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?

Usage is clear from examples like '# Heading > ## Subheading' and 'li[0]', but no explicit when-to-use versus alternatives is given. It does not mention when not to use this tool or point toward sibling tools like nodiom_read_list, so the agent must infer applicability from the name and examples.

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