get_project_readme
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
| Name | Required | Description | Default |
|---|---|---|---|
| ref | No | Branch name, tag, or commit SHA (default: project's default branch) | |
| project | Yes | Project identifier — either a numeric ID (e.g. '12345') or a namespace/project path (e.g. 'atlas/athena') |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||