Skip to main content
Glama
atmOS-10x

knowledge-base

by atmOS-10x

Read a page

kb_read
Read-only

Read any knowledge base page by path, returning the full content or a specific line range.

Instructions

Read a knowledge base page, whole or a line range. Paths are relative to content/ or start with content/.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pathYesPage path, for example policies/expenses.md or content/policies/expenses.md.
endLineNoLast line to return, inclusive. Defaults to the end of the page.
startLineNoFirst line to return, 1-based. Defaults to 1.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.0

TDQS

A3.8/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true and openWorldHint=false, covering non-destructiveness. The description adds that the tool can return the whole page or a line range and clarifies path resolution, which is useful context. It does not discuss error behavior or output format, but with annotations covering the safety profile, this is adequate.

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?

Two short, front-loaded sentences that state the core purpose and a key path convention without waste. No redundant information; every clause earns its place.

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 simple read-only tool, the description covers the main behavioral aspects: whole-page or partial access and path format. There is no output schema, but the return content is implied by 'Read'. Annotations cover safety, making the description nearly complete for an agent to invoke the tool 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 description coverage is 100%, so the parameters are well documented. The description's statement about paths relative to content/ and line ranges is already reflected in the schema examples and default descriptions. It adds minimal meaning beyond the schema.

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?

States a specific verb ('Read') and resource ('knowledge base page'), clearly distinguishing from siblings kb_search, kb_amend, and kb_list. The qualifier 'whole or a line range' adds precision about the scope of the read operation.

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?

Provides a path convention (relative to content/ or start with content/) that aids invocation, but does not explicitly mention when to use this tool versus alternatives like kb_search or kb_list. The intended use case is implied rather than stated.

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

Deploy Server

Other Tools