Skip to main content
Glama

okfindex

Team read base source

team_read_base_source
Read-onlyIdempotent

Read the original 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/no-destructive, and the description goes well beyond them: it discloses that revocation blocks search, originals, Markdown, OKF and ZIP downloads even with an existing session or key, that the initial grant requires the owner's session with origin and CSRF checks, and that responses are private, no-store. It does not describe return format or pagination, so not a 5.

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 the first sentence, which is good, but the remainder is a dense block of access-policy statements. Several clauses (sharing grants for collections, 'Only the resource owner changes sharing') concern the sharing subsystem rather than this read operation and do not clearly earn their place.

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 tool with no output schema, the critical gap is authorization context, and the description supplies it: membership gating, sharing semantics, CSRF/origin requirements for grants, and API-key boundaries. Nothing needed to invoke it correctly appears to be missing, though return-shape expectations are absent.

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 required IDs are already documented in the schema (document_id, base_id, organization_id plus the list_knowledge_teams provenance). The description adds no additional parameter meaning, which is the expected baseline when the schema 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 gives a specific verb and resource: 'Read the original source linked by the OKF concept.' The 'team' scoping is reinforced by the membership/product-access framing. However, it never distinguishes this tool from close siblings like read_base_source, public_read_base_source, or team_read_base_original (source vs. original is left ambiguous).

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?

'Team access uses current account membership, product access and resource sharing on every request' implies this is the team-scoped variant and that membership is a precondition, so usage is implied rather than stated. There is no explicit when-to-use/when-not and no named alternative among the many sibling read tools.

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.