Skip to main content
Glama

PCD (Portable Context Deck)

Read Knowledge

read_knowledge
Read-only

Retrieve knowledge bodies, outlines or selected sections by record ID.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idsNoAlias for record_ids — same shape, same semantics; use either. record_ids wins when both are passed.
contractNoHelp mode — return the complete contract with no operation performed.
sectionsNoSection-addressable read — fetch only the named sections instead of the whole body. Requires exactly ONE record_id. Same addressing as the patch surface: a bare level-2 slug returns that section's subtree (intro + level-3 children); a compound 'parent/child' slug returns just that level-3 sub-section. Unknown slugs are rejected with available_sections listed (no silent partial reads). Response items carry { slug, header, level, hash, markdown } + raw_chapter_hash — hashes flow straight into write_knowledge action='patch' expected_hash. Mutually exclusive with projection.
projectionNoResponse grain. 'full' (default) returns complete bodies — unchanged behaviour. 'summary' returns metadata + summary only, no raw_markdown — the cheap skim when you already hold ids. 'outline' returns metadata + section_tree (section slugs, headers, per-node hashes, word/paragraph counts — no bodies): the read twin of write_knowledge action='describe'. Lean-then-fetch: outline first, then sections for the parts you need.
record_idsNoRecord UUIDs from find_knowledge without query or find_knowledge with query. Cross-container ids are rejected. Required unless `ids` is passed — `ids` is an accepted alias; record_ids wins when both are present.
container_idYesContainer ID — required. Must match the container the ids belong to.
cross_containerNoAccept ids from a cross-container browse/search by relaxing the same-container reject; records annotate their container_id. container_id stays required as the session anchor. Scope never leaves your account. Currently restricted to platform-maintainer accounts; others get a gate error.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed3 schema fields changed
    • addedInput schema / additionalProperties
      Added value: +false
    • changedInput schema / properties / contract / description
      Previous value: -"Help mode — pass true to receive this tool's full _meta.contract (all variants) with NO operation performed."New value: +"Help mode — return the complete contract with no operation performed."
    • changedInput schema / properties / record_ids / description
      Previous value: -"Record UUIDs from browse_knowledge or search_knowledge. Cross-container ids are rejected. Required unless `ids` is passed — `ids` is an accepted alias; record_ids wins when both are present."New value: +"Record UUIDs from find_knowledge without query or find_knowledge with query. Cross-container ids are rejected. Required unless `ids` is passed — `ids` is an accepted alias; record_ids wins when both are present."
  2. First observed

TDQS

A4.4/5.0
Behavior4/5

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

The readOnlyHint annotation is consistent with the read-only nature of the tool. The description adds useful behavioral detail beyond the annotation, such as rejecting unknown slugs with available_sections, mutual exclusions, and the 'no silent partial reads' guarantee.

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?

The top-level description is concise, and the detailed parameter descriptions are well organized. The overall length is justified by the complexity of aliases, projections, and section addressing, though it could be tightened slightly.

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?

There is no output schema, but the description conveys key response characteristics: response item fields for sections, hash propagation, summary/outline content differences, and error behavior. It does not fully describe the top-level response envelope, but it is enough for an agent to understand the main outcomes.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters5/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Although schema coverage is 100%, the description adds substantial meaning: alias resolution, record_ids winning over ids, exactly-one-record requirement for sections, section addressing rules, projection grains, and cross-container restrictions. This goes well beyond the raw 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?

The description uses a specific verb ('Retrieve') with a clear resource ('knowledge bodies, outlines or selected sections') and a clear input ('by record ID'). It distinguishes the read operation from sibling write/search tools like write_knowledge and find_knowledge.

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 provides strong usage guidance through projection semantics, 'lean-then-fetch', and references to find_knowledge and write_knowledge. It does not explicitly say 'use this instead of X', but the retrieval verb and parameter references make the intended context clear.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources