Skip to main content
Glama
AIops-tools

io.github.AIops-tools/ceph-aiops

pg_summary

Assess Ceph PG health: get state histogram and list unhealthy PGs (not active+clean) with configurable limit and truncation indicator.

Instructions

[READ] PG state histogram + every PG that is not active+clean.

Call this to answer "are my PGs healthy?" — it counts PGs by state and lists the ones needing attention. unhealthyCount is the true total; the unhealthy list is capped at limit and sets truncated: true when there were more. Re-run with a higher limit rather than treating a truncated result as complete.

Args: target: Ceph target name from config; omit for the default. limit: Maximum unhealthy PG rows to return. Default 200.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
limitNo
targetNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv0.11.5
    • addedInput schema / properties / limit
      Added value: +{
      +  "default": 200,
      +  "title": "Limit",
      +  "type": "integer"
      +}
  2. First observedv0.1.0

TDQS

A4.8/5.0
Behavior5/5

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

With no annotations, the description carries the full behavioral burden and does so well. It declares this is a READ operation, explains that unhealthyCount is the true total, states that the unhealthy list is capped at limit, and reveals the truncated: true behavior. This goes well beyond the minimal 'returns a summary' explanation.

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?

The description is compact, front-loads the core behavior, and every sentence earns its place. The truncation caveat is critical and placed at the point where it is most useful, followed by a clean Args section.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a read-only summary tool with two optional parameters and no output schema, this description is complete. It gives the agent enough to select the tool, invoke it correctly, interpret the key output fields, and know the truncation caveat.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters5/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 0%, so the description must explain both parameters. It does: target is 'Ceph target name from config; omit for the default', and limit is 'Maximum unhealthy PG rows to return. Default 200.' This fully compensates for the empty schema descriptions.

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?

The description opens with a specific scope: 'PG state histogram + every PG that is not active+clean' and maps it to the question 'are my PGs healthy?'. This clearly distinguishes it from sibling tools like osd_tree or pg_dump_stuck by naming the exact resource and state filter.

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?

It explicitly says 'Call this to answer "are my PGs healthy?"' and adds operational advice about re-running with a higher limit for truncated results. It does not name alternatives or exclusions, so it stops short of a 5, but the context is clear.

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