Skip to main content
Glama
Sign In

Weav

by com.weav
OverviewDiscussionsAdmin

List Help Center article revisions

kb_list_article_revisions
Read-only

List redacted revision summaries for a Help Center public knowledge base article. This is separate from agent training data managed by the *_training_data tools.

Tool call template

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": {
      "article_id": "<article_id>"
    },
    "name": "kb_list_article_revisions"
  }
}

Input Schema

NameRequiredDescriptionDefault
pageNoPage number to return (minimum 1, default 1).
limitNoMaximum revisions per page (1-50, default 20).
localeNoOptionally filter revisions to this locale, such as en or en-US (maximum 10 characters).
article_idYesUUID of the Help Center article whose revisions to list.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A4.2/5.0
Behavior4/5

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

Annotations already declare readOnlyHint, destructiveHint=false and openWorldHint=false, so the safety profile is covered. The description adds genuinely new behavioral information: results are 'redacted revision summaries', telling the agent the payload is summarized/redacted rather than full revision content, which shapes expectations of the response.

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?

Two tight sentences, front-loaded with the primary action and scope, then the disambiguation clause. No filler and nothing duplicated from structured fields.

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?

With no output schema, the description must hint at the return shape, and 'redacted revision summaries' does so. Pagination is delegated to the schema's page/limit parameters. Slightly more detail on what a summary entry contains would make it fully complete, but it is sufficient to call correctly.

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 coverage is 100% and every parameter (page, limit, locale, article_id) is documented in the schema itself, including ranges and defaults. The description adds no format or filtering semantics beyond that, so the baseline 3 is appropriate.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb (List) and resource (revision summaries for a Help Center article), and pins the scope with 'redacted' and 'public knowledge base'. It also explicitly separates itself from the *_training_data tool family, so an agent can place it without opening a schema.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Gives a clear when-not via 'This is separate from agent training data managed by the *_training_data tools', which routes the agent away from the wrong family. It stops short of naming the closest sibling (kb_get_article_revision) for fetching a single, unredacted revision, so the boundary between list vs. get is left to inference.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

All Weav toolsInspect
Try in Browser
One endpoint for every MCP toolRayrun runs every MCP server behind one URL and holds the credentials. Each call is decided per client, tool, and argument, then recorded.ray.runAd

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources