Skip to main content
Glama

get_project_readme

Read-onlyIdempotent

Retrieve a CERN GitLab project's README content to understand what the project does; automatically detects standard README filenames and returns raw content.

Instructions

Get the README file content for a CERN GitLab project. Automatically detects standard README filenames (README.md, README.rst, etc.). Returns the raw content — useful for understanding what a project does.

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": "<project>"
    },
    "name": "get_project_readme"
  }
}

Input Schema

NameRequiredDescriptionDefault
refNoBranch name, tag, or commit SHA (default: project's default branch)
projectYesProject identifier — either a numeric ID (e.g. '12345') or a namespace/project path (e.g. 'atlas/athena')

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv0.4.0
    • changedInput schema / properties / project / description
      Previous value: -"Project identifier — either a numeric ID (e.g. '12345') or a URL-encoded path (e.g. 'atlas/athena')"New value: +"Project identifier — either a numeric ID (e.g. '12345') or a namespace/project path (e.g. 'atlas/athena')"
  2. Changed6 schema fields changedv0.3.0
    • changedInput schema / properties / project / description
      Previous value: -"Project identifier — either a numeric ID (e.g. '12345') or a path (e.g. 'atlas/athena')"New value: +"Project identifier — either a numeric ID (e.g. '12345') or a URL-encoded path (e.g. 'atlas/athena')"
    • addedInput schema / properties / project / title
      Added value: +"Project"
    • addedInput schema / properties / ref / default
      Added value: +""
    • addedInput schema / properties / ref / title
      Added value: +"Ref"
    • addedInput schema / title
      Added value: +"get_project_readme_fnArguments"
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "additionalProperties": true,
      +  "title": "get_project_readme_fnDictOutput",
      +  "type": "object"
      +}
  3. First observedv0.1.6

TDQS

A3.5/5.0
Behavior3/5

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

Annotations already declare readOnly, idempotent, non-destructive and open-world behavior, so the safety profile is covered. The description adds a genuine behavioral trait beyond the schema — automatic filename detection across README variants — but says nothing about what happens when no README exists (error vs empty) or whether large files are truncated.

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?

Three short sentences, front-loaded with the action and resource, then the detection behavior, then the return shape. Minor redundancy between 'Get the README file content' and 'Returns the raw content', but nothing that wastes meaningful space.

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?

A simple two-parameter read tool with rich annotations and an output schema, so the description needn't explain return values or safety. The only meaningful gap is the absence of README-not-found behavior, which is a small omission for a low-complexity tool.

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 description coverage is 100%, with both 'project' (ID or namespace/path) and 'ref' (branch/tag/SHA, default branch) fully documented in the schema. The description adds no additional meaning about these parameters, so the baseline of 3 applies.

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 the README file content for a CERN GitLab project') and clarifies the value-add over a generic file read by noting it 'Automatically detects standard README filenames (README.md, README.rst, etc.)'. It never names the obvious sibling get_file_content, so differentiation is implicit rather than explicit.

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

Usage Guidelines3/5

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

Offers a purpose-oriented hint ('useful for understanding what a project does') which implies when to reach for it, but gives no explicit when-to-use/when-not-to-use guidance versus get_file_content, get_project_info, or inspect_project. The agent must infer that this is preferable to a path-based file read when the README filename is unknown.

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