Skip to main content
Glama
Gerrit OpenAPI MCP

Gerrit OpenAPI MCP

by davido

Getconfigserverindexesindexid

getConfigServerIndexesIndexId

Retrieves Gerrit index details by ID, including version information and which index version handles searches and writes.

Instructions

Get an index used by Gerrit. It provides details about the index versions, which index version is used to search and which versions are written to.

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": {
      "index-id": "<index-id>"
    },
    "name": "getConfigServerIndexesIndexId"
  }
}

Input Schema

NameRequiredDescriptionDefault
index-idYes

Output Schema

NameRequiredDescriptionDefault

No arguments

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 supplied, so the description carries the full burden. 'Get' implies a read-only lookup and the second sentence discloses the kind of configuration data returned, which is useful context, but it says nothing about permissions, behavior when the index-id is unknown, or whether this reflects live or persisted config.

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 short sentences, front-loaded with the action and followed by the payload summary; no filler. Slightly reduced by the loose phrasing of the second sentence, which reads as a run-on list of what the response contains.

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 the description need not restate return shape, and it correctly focuses on the data domain. However, for a tool whose only parameter is undocumented anywhere, the definition leaves the agent guessing about valid index-id values.

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% for the single required parameter, index-id. The description never mentions the parameter, its expected format (e.g. numeric index identifier like 'changes' or 'accounts'), or how to discover valid values via the sibling list tool, so it fails to compensate for the empty schema.

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?

States a specific verb and resource (get an index used by Gerrit) and adds what the payload covers: index versions, the search version, and written versions. It is clearly a single-resource read, distinguishable by its name from the sibling list tools, but it never explicitly contrasts itself with getConfigServerIndexesIndexIdVersions.

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 statement of when to call this versus listing indexes or fetching the versions sub-resource, and no prerequisites or exclusions. Usage is only inferable from the name and the returned-data sentence.

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