Skip to main content
Glama

okfindex

Team read base index

team_read_base_index
Read-onlyIdempotent

Read the private OKF root index. 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.
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 establish the safe-read profile (readOnlyHint, idempotentHint), but the description adds real value beyond them: the authorization model (membership + product access + resource sharing per request), revocation behavior, CSRF/origin requirements for the initial grant, and the 'private, no-store' response policy. This is substantive behavioral context an agent cannot get from the structured fields.

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, which is good, but the bulk of the text is sharing/access-control policy boilerplate that reads as generic to the platform rather than specific to reading a base index. Several sentences (publication semantics, owner-only sharing changes, API key scope) do not help the agent call this particular tool correctly.

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 covers the critical prerequisites: what access is required, that revocation takes effect immediately even with an existing session, and that responses are non-cacheable. It stops short of saying what the OKF root index actually contains, which is the one gap remaining.

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 both base_id and organization_id are already documented, including the list_knowledge_teams and OKFIndex prerequisites. The description adds no format, default, or constraint detail beyond what the schema already states, so the baseline of 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 ('Read the private OKF root index'), so the action is unambiguous. However, it never distinguishes itself from the closely named siblings read_base_index and public_read_base_index, leaving the agent to infer the team scope from the tool name alone.

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 through 'Team access uses current account membership, product access and resource sharing,' which suggests this is the team-context variant. There is no explicit when-to-use statement, no condition selecting it over read_base_index or public_read_base_index, and no exclusions.

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.