get_help_center_analytics
Fetch Help Center performance analytics: total views, CSAT helpfulness rating, top articles, and unanswered search content gaps.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| bot_id | Yes |
Fetch Help Center performance analytics: total views, CSAT helpfulness rating, top articles, and unanswered search content gaps.
| Name | Required | Description | Default |
|---|---|---|---|
| bot_id | Yes |
Changes observed during successful MCP inspections.
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations, the description carries the full behavioral burden; it does imply a read operation and discloses the returned metric categories, which is useful. However, it says nothing about time-range scoping (notably absent from the schema), permissions, or whether metrics are per-article vs aggregate, leaving real gaps for a no-annotation tool.
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?
A single front-loaded sentence that lists the returned metrics with zero filler; every clause adds information.
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 one-parameter read tool with no output schema, the description usefully enumerates the returned metrics. But the total absence of annotation coverage and the undocumented bot_id scoping leave it short of what an agent needs to call it confidently.
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 coverage is 0%, so the single parameter bot_id is completely undocumented in both schema and description. The description should clarify that the analytics are scoped to one bot, but it never mentions bot_id or the scoping implication.
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 uses a specific verb ('Fetch') with a well-defined resource ('Help Center performance analytics') and enumerates the four data categories returned (views, CSAT, top articles, unanswered search gaps). It is clear enough to pick over siblings like get_feedback_and_csat, though it never explicitly names the boundary between them.
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?
There is no statement of when to use this tool, no prerequisites, and no reference to alternatives such as get_feedback_and_csat or discover_knowledge_gaps, which overlap in scope. Usage is only inferable from the name.
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.