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, or one flow stage with its routes, gates and skill.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idsNoAlias for record_ids — same shape, same semantics; use either. record_ids wins when both are passed.
stageNoFlow stage read: the stage's id or name. Needs exactly one record id — a flow — and handle. Returns the stage as written, its declared routes with their conditions, the flow's Gates, Resumption and Records, and the stage's skill as run_pcd_skill returns it from handle. Not with projection, sections or cross_container.
handleNoOnly with stage: your active deck's handle. The stage's skill is read from this deck exactly as run_pcd_skill reads it.
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. Not with stage.
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. Not with stage.
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. Not with stage.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed5 schema fields changed
    • changedInput schema / properties / cross_container / description
      Previous value: -"Accept 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."New value: +"Accept 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. Not with stage."
    • addedInput schema / properties / handle
      Added value: +{
      +  "description": "Only with stage: your active deck's handle. The stage's skill is read from this deck exactly as run_pcd_skill reads it.",
      +  "type": "string"
      +}
    • changedInput schema / properties / projection / description
      Previous value: -"Response 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."New value: +"Response 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. Not with stage."
    • changedInput schema / properties / sections / description
      Previous value: -"Section-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."New value: +"Section-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. Not with stage."
    • addedInput schema / properties / stage
      Added value: +{
      +  "description": "Flow stage read: the stage's id or name. Needs exactly one record id — a flow — and handle. Returns the stage as written, its declared routes with their conditions, the flow's Gates, Resumption and Records, and the stage's skill as run_pcd_skill returns it from handle. Not with projection, sections or cross_container.",
      +  "maxLength": 200,
      +  "minLength": 1,
      +  "type": "string"
      +}
  2. 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."
  3. First observed

TDQS

B3.4/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, so the safety profile is covered. The description itself adds only mode enumeration; behavioral detail like unknown-slug rejection, hash handoff to write_knowledge, and cross-container gating appear in the schema, not the description.

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 front-loaded sentence that enumerates the read modes without filler. It is dense but every clause maps to a real capability; no wasted prose.

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?

For a 9-parameter tool with an output-free design, the one-sentence description is thin, but the 100%-covered schema and read-only annotations carry most of the missing context. Adequate but not self-sufficient.

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% and the parameter docs are extremely rich (aliases, mutual exclusions, hash flow, gates), so the schema does the heavy lifting. The description's mention of bodies/outlines/sections/stage maps onto the projection, sections and stage params but adds no semantics beyond them.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a clear verb ('Retrieve') and enumerates the resources and modes: knowledge bodies, outlines, selected sections, or a single flow stage with routes/gates/skill. It implicitly separates the post-find retrieval case ('by record ID') from search siblings, though it never names find_knowledge explicitly.

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?

The phrase 'by record ID' implies this is used after ids are obtained (i.e. after find_knowledge), which gives usable context. However, there is no explicit when-to-use/when-not statement, no mention of the alternative search tool, and the mutually-exclusive mode rules live only in the schema.

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