Get knowledge base statistics for an agent (VG agents only)
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"agentId": "<agentId>"
},
"name": "get_kb_stats"
}
}| Name | Required | Description | Default |
|---|---|---|---|
| agentId | Yes | The agent ID |
Changes observed during successful MCP inspections.
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The annotations already declare readOnlyHint=true, idempotentHint=true, destructiveHint=false, and openWorldHint=false, so the safety profile is well covered. The description adds the useful 'VG agents only' constraint, but it does not disclose what statistics are returned or any additional behavioral details.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is a single front-loaded sentence with no wasted words. It states the action, resource, and scope constraint immediately.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a simple read-only stats tool with one fully documented parameter and strong annotations, the description is minimally adequate. However, with no output schema, it does not explain what statistics are returned or how they differ from get_kb_quota, leaving a notable gap for an agent deciding whether to call it.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the single agentId parameter is already documented. The description adds the 'VG agents only' scope constraint, which gives meaningful context for the agentId, but does not otherwise enrich parameter semantics beyond the schema.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states a specific verb and resource: 'Get knowledge base statistics.' The parenthetical '(VG agents only)' adds a meaningful scope constraint that helps distinguish it from KB tools like get_kb_quota or list_kb_docs, though it does not explicitly name sibling alternatives.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Usage is only implied by the phrase 'for an agent (VG agents only).' There is no explicit guidance on when to use this tool versus get_kb_quota, list_kb_docs, or other KB-related siblings, but the agent-specific context provides enough to infer basic usage.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Add one secure layer between your agents and this server.