list_faq
List published public frequently asked questions.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| language | No | zh-CN |
List published public frequently asked questions.
| Name | Required | Description | Default |
|---|---|---|---|
| language | No | zh-CN |
Changes observed during successful MCP inspections.
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint, idempotentHint, non-destructive and closed-world, so the safety profile is fully covered elsewhere. The description's one contribution is the 'published public' filter, which tells the agent unpublished or private FAQs are excluded — useful, but no mention of result ordering, limits, or pagination.
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 short sentence with no filler, front-loading the verb and scope. Efficient, though brevity comes at the cost of the missing parameter and usage detail.
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 list tool with rich annotations and no output schema, the description covers what is returned at a high level. It falls short on the language parameter's effect and on when to prefer get_faq, leaving real gaps for an agent choosing between the two.
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 0% and the single parameter ('language', enum zh-CN/en, default zh-CN) is not mentioned in the description at all. With one parameter and zero schema documentation, the description should compensate and does not.
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?
States a specific verb and resource ('list ... frequently asked questions') plus a scope qualifier ('published public'), which separates it from get_faq by implying a collection rather than a single item. It does not explicitly name any sibling, so the differentiation is inferred rather than stated.
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 when-to-use guidance at all: nothing says to call this instead of get_faq when a specific question is needed, nor any prerequisites or exclusions. The only hint is the 'list' versus 'get' naming convention shared with siblings.
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.