Skip to main content
Glama

okfindex

Team read base markdown

team_read_base_markdown
Read-onlyIdempotent

Download document Markdown. Team access uses current account membership, product access and resource sharing on every request. Revocation also blocks search, originals, Markdown, OKF and ZIP downloads with an existing session or key. Sharing a collection grants current and future files in its owner's referenced bases; other owners' bases expose published files only. Sharing does not publish a resource. Only the resource owner changes sharing. The initial grant requires the owner's session with origin and CSRF checks. Organization API keys stay within their existing grants. Responses use private, no-store.

Input Schema

NameRequiredDescriptionDefault
base_idYesThe 64-character ID returned by the API.
document_idYesThe 64-character ID returned by the API.
organization_idYesAn existing organization ID from list_knowledge_teams. The account must be an active member and OKFIndex must be enabled.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added
  2. Removed
  3. Added

TDQS

A3.6/5.0
Behavior5/5

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

With annotations only covering the safe-read profile (readOnly, idempotent, non-destructive), the description adds substantial context the annotations do not: per-request membership/product/sharing evaluation, revocation blocking search and downloads even with an existing session, CSRF/origin requirements on the initial grant, and private, no-store caching. These are genuinely useful operational traits.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness3/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The purpose is front-loaded in one sentence, but it is then followed by a long policy block covering collection sharing, publishing, and ownership that applies broadly across the API rather than to this specific read. Several sentences feel tangential and could be trimmed without losing tool-specific meaning.

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 read-only tool with full schema coverage and no output schema, the description supplies the important access and caching behavior an agent needs. It does not describe the returned Markdown format or response handling, but the resource name makes the payload clear enough.

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 all three IDs are already documented in the schema. The description reinforces that the org requires active membership and OKFIndex, but adds no format or usage detail beyond what the schema states. Baseline 3 applies.

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?

"Download document Markdown" states a specific verb and resource, and the team scope is implied by the name and membership language. However, it never distinguishes itself from the many near-identical siblings (read_base_markdown, public_read_base_markdown, team_read_base_original/index), so an agent cannot tell from the text alone which variant to pick.

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

Usage Guidelines2/5

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

The description explains access-control behavior but never states when to use this tool versus read_base_markdown or the public_* equivalents. There are no exclusions or routing conditions, leaving the agent to infer selection from the tool name alone.

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.