Skip to main content
Glama

okfindex

Team read base doc source

team_read_base_doc_source
Read-onlyIdempotent

Download the DOC source linked by the OKF concept. 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
Behavior4/5

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

Annotations already declare readOnlyHint/idempotentHint/non-destructive, but the description adds real behavior beyond them: revocation semantics ('Revocation also blocks search, originals, Markdown, OKF and ZIP downloads with an existing session or key'), the origin/CSRF requirement for the initial grant, API-key scope limits, and 'private, no-store' caching. It omits error/denial behavior for non-members, but the added context is substantial.

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 core purpose is correctly front-loaded in sentence one, but the remaining text is a long block of platform-wide sharing/revocation policy with several sentences ('Sharing does not publish a resource. Only the resource owner changes sharing.') that read as boilerplate repeated across the family rather than tool-specific guidance.

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?

With annotations carrying the safety profile and the schema at full coverage, the description supplies the missing team-access contract. The main residual gap is the return payload — 'Download' suggests file content but no output schema exists and no format/response description is given beyond the no-store note.

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 (organization_id, base_id, document_id) are documented in the schema, including the membership/OKFIndex prerequisite for organization_id. The description adds no additional parameter meaning, so the 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?

The first sentence gives a specific verb and resource: 'Download the DOC source linked by the OKF concept.' It is distinguishable from the docx/pdf/markdown/original siblings, though it never explicitly contrasts itself with read_base_doc_source or public_read_base_doc_source, leaving the tier distinction (team vs. personal vs. public) to be inferred from the name.

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 description states the access model ('Team access uses current account membership, product access and resource sharing on every request'), which implies when this team-scoped tool applies, but it never explicitly says 'use this instead of read_base_doc_source when...'. Usage is implied rather than directed.

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.