Skip to main content
Glama
zereight

gitlab mcp

by zereight
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Remote

get_ci_catalog_resource

Read-only

Retrieve versions and components of a known GitLab CI/CD Catalog resource by ID or full path. Read-only operation returning filtered details, with errors for missing resources or permission issues.

Instructions

Get details for a GitLab CI/CD Catalog resource, including versions and components. Use this for a known resource or result; choose the corresponding list or search tool when you need to discover multiple resources. It is read-only and does not mutate GitLab data; missing resources, invalid identifiers, insufficient permission, and rate limits are returned as errors. When project_id or group_id is accepted, provide the numeric ID or complete URL-encoded path described by the schema; use required identifiers and pagination fields exactly as documented.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idNoCI/CD Catalog resource global ID. Required when full_path is omitted.
jmespathNoOptional JMESPath expression filtering the JSON result before return.
full_pathNoCI/CD Catalog resource full project path. Required when id is omitted.
version_limitNoNumber of versions to include (default: 5, max: 20)
component_nameNoFilter returned components by component name
include_readmeNoInclude version README content
component_limitNoNumber of components per version to include (default: 20, max: 50)

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv2.1.66
    • addedInput schema / properties / jmespath
      Added value: +{
+  "description": "Optional JMESPath expression filtering the JSON result before return.",
+  "type": "string"
+}
  2. Changed1 schema field changedv2.1.28
    • removedInput schema / anyOf
      Removed value: -[
-  {
-    "properties": {
-      "component_limit": {
-        "description": "Number of components per version to include (default: 20, max: 50)",
-        "maximum": 50,
-        "minimum": 1,
-        "type": "integer"
-      },
-      "component_name": {
-        "description": "Filter returned components by component name",
-        "type": "string"
-      },
-      "full_path": {
-        "description": "CI/CD Catalog resource full project path. Required when id is omitted.",
-        "minLength": 1,
-        "type": "string"
-      },
-      "id": {
-        "description": "CI/CD Catalog resource global ID. Required when full_path is omitted.",
-        "minLength": 1,
-        "type": "string"
-      },
-      "include_readme": {
-        "description": "Include version README content",
-        "type": "boolean"
-      },
-      "version_limit": {
-        "description": "Number of versions to include (default: 5, max: 20)",
-        "maximum": 20,
-        "minimum": 1,
-        "type": "integer"
-      }
-    },
-    "required": [
-      "id"
-    ],
-    "type": "object"
-  },
-  {
-    "properties": {
-      "component_limit": {
-        "description": "Number of components per version to include (default: 20, max: 50)",
-        "maximum": 50,
-        "minimum": 1,
-        "type": "integer"
-      },
-      "component_name": {
-        "description": "Filter returned components by component name",
-        "type": "string"
-      },
-      "full_path": {
-        "description": "CI/CD Catalog resource full project path. Required when id is omitted.",
-        "minLength": 1,
-        "type": "string"
-      },
-      "id": {
-        "description": "CI/CD Catalog resource global ID. Required when full_path is omitted.",
-        "minLength": 1,
-        "type": "string"
-      },
-      "include_readme": {
-        "description": "Include version README content",
-        "type": "boolean"
-      },
-      "version_limit": {
-        "description": "Number of versions to include (default: 5, max: 20)",
-        "maximum": 20,
-        "minimum": 1,
-        "type": "integer"
-      }
-    },
-    "required": [
-      "full_path"
-    ],
-    "type": "object"
-  }
-]
  3. Addedv2.1.26

TDQS

A4.1/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true, so the read-only claim is redundant, but the description adds valuable behavioral context: missing resources, invalid identifiers, insufficient permission, and rate limits are returned as errors. This goes beyond the annotations and is useful for an agent deciding whether to call the tool or handle failures.

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

Conciseness3/5

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

The first two sentences are concise and high-value, but the final sentence is generic boilerplate that references nonexistent parameters and does not earn its place. The description would be stronger if it ended after the error-handling sentence or corrected the parameter guidance.

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

Completeness4/5

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

For a read-only single-resource retrieval tool with 100% schema coverage, the description is largely complete: it explains scope, alternatives, error behavior, and safety. The main gap is the stale parameter note, which slightly undermines the otherwise solid context. An output schema is absent, but the description at least names the returned content (versions and components).

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 coverage is 100%, so the baseline is 3, but the description adds misleading guidance: it references `project_id` or `group_id`, which do not exist in the schema (the schema uses `id` and `full_path`). The instruction to 'use required identifiers and pagination fields' is also vague and not backed by the schema, which has no required parameters. The description does not clarify the actual id/full_path trade-off beyond what the schema already states.

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 states a specific verb and resource: 'Get details for a GitLab CI/CD Catalog resource, including versions and components.' It also explicitly distinguishes itself from list/search discovery tools by saying to use those when discovering multiple resources. This clearly differentiates it from the sibling list_ci_catalog_resources.

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?

It gives explicit when-to-use guidance: 'Use this for a known resource or result; choose the corresponding list or search tool when you need to discover multiple resources.' This names the condition and points to an alternative, leaving little inference for the agent.

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