Skip to main content
Glama

get_doc

Read a stored Markdown document, such as getting-started, tools, or context, from openport's shared memory to retrieve scoped guidance for an agent.

Instructions

Read a markdown doc from memory (getting-started, tools, context, …).

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "doc": "<doc>"
    },
    "name": "get_doc"
  }
}

Input Schema

NameRequiredDescriptionDefault
docYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.3.3

TDQS

A3.6/5.0
Behavior3/5

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

With no annotations, the description carries the full burden and only communicates that this is a read of markdown content. It says nothing about behavior for unknown doc names, error handling, truncation, or the shape of returned content.

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?

One sentence, front-loaded with the action and resource, with the value examples folded in efficiently. Nothing is wasted.

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 single-parameter, no-output-schema tool this is close to sufficient, but the truncated example list (…) means an agent cannot know the full set of retrievable doc keys without trial. A short note on which docs exist or how to discover them would close the gap.

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 0% and the sole parameter 'doc' is an unconstrained string, so the parenthetical examples (getting-started, tools, context, …) are the only signal of valid values. That is meaningful compensation, though the trailing ellipsis leaves the value space open-ended.

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?

The description gives a specific verb (Read) and resource (markdown doc from memory), which is immediately distinguishable from the write-oriented update_doc sibling. It does not explicitly contrast with get_context, get_skill, or learn_workflow, so the verb alone carries the differentiation.

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 only implied by the read framing; there is no statement of when to prefer this over get_context, get_skill, or learn_workflow. The parenthetical examples hint at the domain of retrieval but do not establish selection criteria.

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