Skip to main content
Glama

okfindex

Team get base document

team_get_base_document
Read-onlyIdempotent

Read the document Markdown and metadata. 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

B3.2/5.0
Behavior4/5

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

Annotations already declare readOnly/idempotent/non-destructive, so the bar is lower, yet the description still adds real behavioral context: access is re-evaluated on every request, revocation also blocks search/originals/Markdown/OKF/ZIP, the initial grant requires the owner's session with origin and CSRF checks, and responses are private/no-store. Those are access and caching traits an agent cannot get from the annotations.

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

Conciseness2/5

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

The first sentence is front-loaded and useful, but it is followed by a dense block of access-control boilerplate covering search, ZIP downloads, publishing, collection sharing, and CSRF that is mostly generic to the product rather than specific to reading one document. Much of it does not earn its place for this tool.

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 read-only tool with full annotation coverage and a complete output-less schema, the definition covers the authorization model adequately. It still omits anything about the response shape (Markdown vs metadata payload), pagination, or document-size limits, and the boilerplate dilutes the tool-specific guidance.

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 all three parameters are documented in-schema (base_id, document_id, organization_id with the membership/OKFIndex requirement). The description adds no per-parameter meaning, so this is the baseline 3 for a schema that does the heavy lifting.

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 opening sentence names a specific verb and resource: 'Read the document Markdown and metadata.' That is clear. However, it never distinguishes this team variant from the many near-identical siblings (get_base_document, team_read_base_markdown, team_read_base_source), so an agent cannot tell from the text why it should pick this tool over those.

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?

There is no explicit when-to-use or when-not-to-use guidance, and no sibling is named as an alternative. The text implies a team-scoped read via the access model, but an agent is left to infer whether this is the team-authorized counterpart of get_base_document or something else.

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.