Skip to main content
Glama
Gerrit OpenAPI MCP

Gerrit OpenAPI MCP

by davido

Getprojectsprojectiddescription

getProjectsProjectIdDescription

Retrieve the description of a Gerrit project by its project ID to review or confirm the project's stated purpose before making changes or configuring repositories.

Instructions

Retrieves the description of a project.

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": {
      "project-id": "<project-id>"
    },
    "name": "getProjectsProjectIdDescription"
  }
}

Input Schema

NameRequiredDescriptionDefault
project-idYes

Output Schema

NameRequiredDescriptionDefault
resultNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

C2.8/5.0
Behavior2/5

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

No annotations are supplied, so the description carries the full behavioral burden. The word 'Retrieves' weakly implies a read, but nothing is said about permissions or visibility requirements, what happens if the description is unset, or how project visibility affects the result.

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?

One short, front-loaded sentence with no filler. It is efficient, though the brevity reflects under-specification rather than disciplined trimming.

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. However, with zero annotation coverage, zero schema description coverage, and a large sibling catalog, the definition is thinner than the situation warrants, leaving identifier format and usage routing unresolved.

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, and the description does not compensate. It never explains whether project-id is a numeric ID or a URL-encoded namespace/project path, which is a common and consequential ambiguity in this kind of API.

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: it retrieves a project's description field. That is distinguishable in intent from broader siblings like getProjectsProjectId, but the definition never explicitly frames the relationship, so an agent must infer that this is the narrow field-level read.

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 when-to-use guidance at all. The sibling set contains many project-scoped getters (getProjectsProjectId, getProjectsProjectIdConfig, getProjectsProjectIdAccess), and the description offers no cue about when to call this instead of fetching the full project object.

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