Skip to main content
Glama
Gerrit OpenAPI MCP

Gerrit OpenAPI MCP

by davido

Getgroupsgroupiddescription

getGroupsGroupIdDescription

Retrieve the description text of a Gerrit group by its group ID, so you can inspect what the group is for before managing memberships or permissions.

Instructions

Retrieves the description of a group.

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": {
      "group-id": "<group-id>"
    },
    "name": "getGroupsGroupIdDescription"
  }
}

Input Schema

NameRequiredDescriptionDefault
group-idYes

Output Schema

NameRequiredDescriptionDefault
resultNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

B3/5.0
Behavior3/5

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

No annotations are provided, so the description carries the full burden; 'Retrieves' correctly signals a read-only, side-effect-free operation. However, it says nothing about permission requirements or error behavior (e.g., what happens for an unknown group-id), leaving gaps for a tool with zero annotation coverage.

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?

A single front-loaded sentence with no wasted words. It is efficient, though its brevity borders on under-specification rather than true conciseness.

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

Completeness3/5

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

An output schema exists, so return values need not be explained, and the operation is simple enough that minimal description is nearly sufficient. Still missing is any differentiation from getGroupsGroupId and any detail on the group-id input, which an agent needs to call it correctly.

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

Parameters2/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 compensate for the undocumented group-id parameter, and it does not. The name is self-explanatory as a group identifier, but no format, ID type, or sourcing guidance is given.

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

Purpose4/5

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

The description states a specific verb and resource ('Retrieves the description of a group'), and the resource name implicitly distinguishes it from siblings like getGroupsGroupIdName or getGroupsGroupIdOwner. It stops short of explicitly telling the agent how it differs from getGroupsGroupId, which likely also returns a description field.

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

Usage Guidelines2/5

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

There is no guidance on when to use this endpoint rather than the more general getGroupsGroupId, nor any stated prerequisites. The agent must infer that this is the lightweight way to fetch only the description field.

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

Deploy Server

Other Tools