Skip to main content
Glama

ringkit_get_knowledge_usage

Read-onlyIdempotent

Read the knowledge tier (starter | pro), its limits, and how many documents/tokens are used.

Input Schema

NameRequiredDescriptionDefault
businessIdNoDefaults to the business of the API key in the Authorization header.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.8/5.0
Behavior4/5

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

The annotations already declare readOnlyHint, idempotentHint, destructiveHint=false and a closed-world scope, so the safety profile is covered. The description's real contribution is disclosing what the call returns (tier, limits, documents/tokens used) — useful since there is no output schema. It doesn't mention freshness of the counters or whether limits are monthly, which keeps it below 5.

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

Conciseness5/5

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

One short front-loaded sentence that names the tier enum values inline and enumerates the returned facts without any filler.

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 parameterless read with no output schema, the description covers the essential return surface (tier, limits, document/token counts). It could say more about the units of consumption (e.g. whether token counts are per-period), but nothing critical to invoking it correctly is missing.

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?

There is a single optional businessId parameter with 100% schema description coverage, so the schema already explains its default from the API key's business. The description adds no further meaning about that parameter, making the 3 baseline correct.

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 description states a specific verb ('Read') and a specific resource ('knowledge tier... its limits, and how many documents/tokens are used'), which clearly separates it from ringkit_get_knowledge and ringkit_list_knowledge_documents. It does not explicitly name those siblings, so it stops short of full differentiation.

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: an agent infers this is the quota/consumption check to run before importing or uploading documents. There is no explicit when-to-use statement, no comparison to the sibling tools that also touch knowledge, and no exclusion guidance.

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.

Resources