Skip to main content
Glama
knaisoma

data-olympus MCP server

KB Get Document

kb_get
Read-onlyIdempotent

Retrieve a document by id (STD-U-001, ADR-002, T-NNN, etc.). Returns the full content markdown plus metadata. Use this when you have a specific id (from kb_search results or session memory); use kb_search instead when you need to find…

Instructions

Retrieve a document by id (STD-U-001, ADR-002, T-NNN, etc.). Returns the full content markdown plus metadata. Use this when you have a specific id (from kb_search results or session memory); use kb_search instead when you need to find a document by topic.

Always resolves regardless of expiry (ids never dangle): an expired document is still returned, with its full validity object and a computed freshness indicator (stale/expired/upcoming).

Derivation cues (ids only, for a person to review; nothing is filtered or demoted because of them): derived_from lists the documents this one draws from; derived_from_retired lists those that have left force, only while this document is itself in force; and dependents_to_review lists the in-force documents that derive from this one, only while this document is retired.

verbose: False (default) returns the full content_markdown body (kb_get exists to read the doc) with a trimmed envelope: path, git_remote_url, and last_modified_source are dropped and empty status/type/applies_when/description/validity/freshness are omitted; source_commit and last_modified provenance are kept, and in_force: false is emitted when the computed in-force predicate says the doc does NOT currently govern (deviation-only; an in-force doc omits the key). verbose=True returns the full legacy envelope with every field plus the computed in_force: bool (the single-sourced status + validity-window + not-inbox predicate; never stored in frontmatter).

Input Schema

NameRequiredDescriptionDefault
idYesStable KB document id to retrieve.
verboseNoFalse returns the compact response; true includes all fields.

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.5.0

TDQS

A4.8/5.0
Behavior5/5

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

Annotations already declare readOnly/idempotent/non-destructive, and the description still adds non-obvious behavior: retrieval always resolves even for expired docs ('ids never dangle'), what freshness values can appear (stale/expired/upcoming), and that derivation cues are advisory and never filter results. That is real behavioral disclosure beyond structured fields, not restatement.

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?

Purpose and the kb_search alternative are front-loaded, and each paragraph has a distinct job. The verbose paragraph and derivation-cue taxonomy are dense and partially overlap with the output schema, so it is slightly heavier than strictly necessary for a two-parameter read.

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

Completeness5/5

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

For a read tool with an output schema and full annotation coverage, everything an agent needs is present: id sourcing, expiry behavior, freshness/in_force semantics, and the verbose mode tradeoff. No invocation-relevant gap remains and return-shape detail is correctly left to the output schema.

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

Parameters4/5

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

Schema coverage is 100%, so the baseline is 3, but the description goes further on `verbose`: it enumerates which fields are dropped (path, git_remote_url, last_modified_source), which are kept (source_commit, last_modified), and the asymmetric `in_force: false` emission rule. The schema's 'compact response / all fields' phrasing does not convey any of that.

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?

Specific verb+resource ('Retrieve a document by id') with concrete id-format examples (STD-U-001, ADR-002, T-NNN). It explicitly names the sibling kb_search and states the dividing line between lookup-by-id and lookup-by-topic, so the agent can discriminate without opening schemas.

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

Usage Guidelines5/5

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

States when to use it ('when you have a specific id, from kb_search results or session memory') and names the alternative with the condition that selects it ('use kb_search instead when you need to find a document by topic'). Both directions of routing are covered.

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