Skip to main content
Glama

Describe a raidcom command

raidcom_describe_command
Read-onlyIdempotent

Describes a raidcom command's purpose, supported models, syntax forms, options, and examples so you can confirm what to build before constructing the command line.

Instructions

Everything needed to build one raidcom command: what it does, which models support it, whether it is read-only, destructive or asynchronous, each syntax form, every option with the number and kind of values it takes (and the words it accepts, where it accepts only a few), and examples. Call it before raidcom_build_command when you are unsure which options a command needs or which of its syntax forms fits the request.

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": {
      "command": "<command>"
    },
    "name": "raidcom_describe_command"
  }
}

Input Schema

NameRequiredDescriptionDefault
optionNoOnly describe this option, e.g. "-ldev_id".
commandYesCommand name, e.g. "add lun" or "raidcom get ldev".

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.8

TDQS

A4.4/5.0
Behavior5/5

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

With no output schema, the description carries the full burden of describing the return payload and does so concretely: model support, safety flags (read-only/destructive/asynchronous), each syntax form, per-option value counts and accepted keywords, and examples. It also complements the readOnlyHint by naming the per-command safety attributes the caller will see.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Two sentences, front-loaded with the payload description followed by the call-to-action. The enumeration clause is long but each item is informative about the return value, so little waste remains.

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?

A simple two-parameter read tool with no output schema, and the description fully specifies what the response contains and when to invoke it. Nothing an agent needs in order to call it correctly is missing.

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 both parameters carry examples ('-ldev_id', 'add lun'), so the schema does the heavy lifting. The description's phrase 'every option' hints at what the option parameter narrows but adds no format or filtering detail beyond the schema.

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 and resource ('describe a raidcom command') and enumerates what the description returns: behavior, model support, read-only/destructive/async status, syntax forms, options and examples. An agent can distinguish it from raidcom_build_command or raidcom_list_commands 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?

Explicitly says to call it before raidcom_build_command when unsure which options or syntax form fits, giving a clear trigger and a named alternative. It does not distinguish itself from raidcom_check_command or raidcom_list_commands, so the 'when-not' side is incomplete.

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