Skip to main content
Glama
vmware-skills

io.github.zw008/vmware-log-insight

alert_list

Read-onlyIdempotent

List defined alert rules with optional name filtering and result limits, returning alert IDs and details for further inspection.

Instructions

[READ] List defined Log Insight alerts.

name_filter = optional case-insensitive substring on alert name. limit = max results (default 50). target = target name from config. Returns the family list envelope {items, returned, limit, total, truncated, hint}; each item is {id, name, enabled, info}. Start here, then pass an id to alert_get or alert_history. total is the real count matching name_filter, so truncated answers whether more exist; raise limit or narrow name_filter when true. Read-only — this skill never creates/edits/deletes alerts.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
limitNo
targetNo
name_filterNo
Behavior5/5

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

Beyond annotations (readOnly, idempotent), the description adds substantial behavioral context: it explains the return envelope structure, that total is the real count, and how truncated indicates whether more results exist. It also states the operation is read-only explicitly, reinforcing annotations without contradiction.

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 concise yet dense, with a clear structure: purpose, parameters, return format, workflow, pagination note, and safety disclaimer. Every sentence adds value, and the use of inline code-like formatting for field names improves readability without bloat.

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?

With no output schema, the description carries the full burden of explaining return values—it does so with the envelope format and item structure. It also covers pagination semantics, parameter meanings, and the recommended workflow, making it complete for a list tool of this complexity.

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%, but the description fully compensates by explaining each parameter: name_filter is a case-insensitive substring, limit is max results (default 50), and target is a target name from config. This provides essential meaning that the schema lacks.

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 clearly states 'List defined Log Insight alerts' with a specific verb and resource. It also distinguishes from sibling tools by explicitly saying 'Start here, then pass an id to alert_get or alert_history', positioning itself as the entry point for listing alerts.

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

Usage Guidelines5/5

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

Provides explicit workflow guidance: 'Start here' for listing, then use alert_get or alert_history for details. Also gives actionable pagination advice: 'raise limit or narrow name_filter when truncated is true.' This clearly indicates when to use this tool versus alternatives.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/vmware-skills/VMware-Log-Insight'

If you have feedback or need assistance with the MCP directory API, please join our Discord server