{"openapi":"3.1.0","info":{"title":"GitLab CI (BYOK) API","version":"0.1.0","description":"GitLab CI (BYOK) lets an AI assistant read your own GitLab CI data through the GitLab CI API with a key you supply (personal access token (read_api scope)). Read-only: 12 tools (list_project_jobs, get_job, list_pipeline_jobs, list_pipeline_trigger_jobs, get_latest_pipeline, get_pipeline_test_report_summary, validate_ci_config, list_resource_groups, get_resource_group,...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-gitlab-ci.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-gitlab-ci/docs"},"termsOfService":"https://connectorbay.com/byok-gitlab-ci/terms"},"servers":[{"url":"https://byok-gitlab-ci.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-gitlab-ci/docs"},"security":[{"upstreamKey":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","description":"Optional. A Pro API key raises rate limits; no credentials are required."},"upstreamKey":{"type":"apiKey","in":"header","name":"X-Upstream-Key","description":"Your own key for the service this connector wraps (bring your own key). Used for that one call only; never stored, logged or cached."}},"schemas":{"Error":{"type":"object","properties":{"ok":{"const":false},"error":{"type":"object"}}}}},"paths":{"/v1/tools/list_project_jobs":{"post":{"operationId":"list_project_jobs","summary":"List the CI jobs of a project, newest first, with stage, status, failure reason, duration and pipeline. Commit and user ","description":"List the CI jobs of a project, newest first, with stage, status, failure reason, duration and pipeline. Commit and user details are left out. Use for \"Which CI jobs failed recently in gitlab-org/gitlab\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"project":{"description":"Numeric project ID, or the full path with namespace such as 'gitlab-org/gitlab' (slashes are encoded for you).","maxLength":200,"title":"Project","type":"string"},"scope":{"anyOf":[{"enum":["created","pending","running","failed","success","canceling","canceled","skipped","waiting_for_resource","manual","scheduled"],"type":"string"},{"type":"null"}],"default":null,"description":"Only jobs in this status.","title":"Scope"},"per_page":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"How many results to return (1 to 100).","title":"Per Page"},"page":{"anyOf":[{"maximum":10000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"}},"required":["project"],"title":"list_project_jobsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_job":{"post":{"operationId":"get_job","summary":"Get one CI job: name, stage, status, failure reason, ref, coverage, timings and the pipeline it belongs to. Use for \"Wha","description":"Get one CI job: name, stage, status, failure reason, ref, coverage, timings and the pipeline it belongs to. Use for \"What happened in job 7 of gitlab-org/gitlab\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"project":{"description":"Numeric project ID, or the full path with namespace such as 'gitlab-org/gitlab' (slashes are encoded for you).","maxLength":200,"title":"Project","type":"string"},"job_id":{"description":"Numeric ID of the job (from a job list).","title":"Job Id","type":"integer"}},"required":["project","job_id"],"title":"get_jobArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_pipeline_jobs":{"post":{"operationId":"list_pipeline_jobs","summary":"List the jobs of one pipeline (retried jobs only on request), with stage, status, failure reason and timings. Use for \"W","description":"List the jobs of one pipeline (retried jobs only on request), with stage, status, failure reason and timings. Use for \"Which jobs ran in pipeline 287 of gitlab-org/gitlab\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"project":{"description":"Numeric project ID, or the full path with namespace such as 'gitlab-org/gitlab' (slashes are encoded for you).","maxLength":200,"title":"Project","type":"string"},"pipeline_id":{"description":"Numeric ID of the pipeline (from a pipeline list).","title":"Pipeline Id","type":"integer"},"include_retried":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":false,"description":"True to also list jobs that were retried.","title":"Include Retried"},"scope":{"anyOf":[{"enum":["created","pending","running","failed","success","canceling","canceled","skipped","waiting_for_resource","manual","scheduled"],"type":"string"},{"type":"null"}],"default":null,"description":"Only jobs in this status.","title":"Scope"},"per_page":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"How many results to return (1 to 100).","title":"Per Page"},"page":{"anyOf":[{"maximum":10000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"}},"required":["project","pipeline_id"],"title":"list_pipeline_jobsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_pipeline_trigger_jobs":{"post":{"operationId":"list_pipeline_trigger_jobs","summary":"List the trigger jobs of a pipeline (the jobs that start downstream or child pipelines) with status and the downstream p","description":"List the trigger jobs of a pipeline (the jobs that start downstream or child pipelines) with status and the downstream pipeline. Use for \"Which downstream pipelines did pipeline 287 of gitlab-org/gitlab trigger\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"project":{"description":"Numeric project ID, or the full path with namespace such as 'gitlab-org/gitlab' (slashes are encoded for you).","maxLength":200,"title":"Project","type":"string"},"pipeline_id":{"description":"Numeric ID of the pipeline (from a pipeline list).","title":"Pipeline Id","type":"integer"},"scope":{"anyOf":[{"enum":["created","pending","running","failed","success","canceling","canceled","skipped","waiting_for_resource","manual","scheduled"],"type":"string"},{"type":"null"}],"default":null,"description":"Only jobs in this status.","title":"Scope"},"per_page":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"How many results to return (1 to 100).","title":"Per Page"},"page":{"anyOf":[{"maximum":10000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"}},"required":["project","pipeline_id"],"title":"list_pipeline_trigger_jobsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_latest_pipeline":{"post":{"operationId":"get_latest_pipeline","summary":"Get the latest pipeline of a branch or tag (default branch when no ref is given): status, source, commit SHA, timings an","description":"Get the latest pipeline of a branch or tag (default branch when no ref is given): status, source, commit SHA, timings and coverage. Use for \"What is the status of the latest pipeline on main in gitlab-org/gitlab\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"project":{"description":"Numeric project ID, or the full path with namespace such as 'gitlab-org/gitlab' (slashes are encoded for you).","maxLength":200,"title":"Project","type":"string"},"ref":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Branch or tag to look at. Defaults to the project's default branch.","title":"Ref"}},"required":["project"],"title":"get_latest_pipelineArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_pipeline_test_report_summary":{"post":{"operationId":"get_pipeline_test_report_summary","summary":"Get the unit test report summary of a pipeline: total, passed, failed, skipped and errored tests and the totals per test","description":"Get the unit test report summary of a pipeline: total, passed, failed, skipped and errored tests and the totals per test suite. Use for \"How many tests failed in pipeline 287 of gitlab-org/gitlab\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"project":{"description":"Numeric project ID, or the full path with namespace such as 'gitlab-org/gitlab' (slashes are encoded for you).","maxLength":200,"title":"Project","type":"string"},"pipeline_id":{"description":"Numeric ID of the pipeline (from a pipeline list).","title":"Pipeline Id","type":"integer"}},"required":["project","pipeline_id"],"title":"get_pipeline_test_report_summaryArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/validate_ci_config":{"post":{"operationId":"validate_ci_config","summary":"Check the project's current .gitlab-ci.yml (or the one on a given ref) and report whether it is valid, with errors and w","description":"Check the project's current .gitlab-ci.yml (or the one on a given ref) and report whether it is valid, with errors and warnings. Nothing is changed. Use for \"Is the CI configuration of gitlab-org/gitlab valid\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"project":{"description":"Numeric project ID, or the full path with namespace such as 'gitlab-org/gitlab' (slashes are encoded for you).","maxLength":200,"title":"Project","type":"string"},"content_ref":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Commit SHA, branch or tag to read the CI configuration from. Defaults to the head of the default branch.","title":"Content Ref"}},"required":["project"],"title":"validate_ci_configArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_resource_groups":{"post":{"operationId":"list_resource_groups","summary":"List a project's CI resource groups (they limit concurrent deployments) with key and process mode. Use for \"Which resour","description":"List a project's CI resource groups (they limit concurrent deployments) with key and process mode. Use for \"Which resource groups does gitlab-org/gitlab use to serialize deployments\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"project":{"description":"Numeric project ID, or the full path with namespace such as 'gitlab-org/gitlab' (slashes are encoded for you).","maxLength":200,"title":"Project","type":"string"}},"required":["project"],"title":"list_resource_groupsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_resource_group":{"post":{"operationId":"get_resource_group","summary":"Get one CI resource group: key, process mode and timestamps. Use for \"What is the process mode of the production resourc","description":"Get one CI resource group: key, process mode and timestamps. Use for \"What is the process mode of the production resource group in gitlab-org/gitlab\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"project":{"description":"Numeric project ID, or the full path with namespace such as 'gitlab-org/gitlab' (slashes are encoded for you).","maxLength":200,"title":"Project","type":"string"},"group_key":{"description":"Key of the resource group, for example 'production' (from list_resource_groups).","maxLength":200,"title":"Group Key","type":"string"}},"required":["project","group_key"],"title":"get_resource_groupArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_resource_group_upcoming_jobs":{"post":{"operationId":"list_resource_group_upcoming_jobs","summary":"List the jobs waiting for a resource group, in the order they will run. Use for \"Which deploy jobs are queued behind the","description":"List the jobs waiting for a resource group, in the order they will run. Use for \"Which deploy jobs are queued behind the production resource group in gitlab-org/gitlab\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"project":{"description":"Numeric project ID, or the full path with namespace such as 'gitlab-org/gitlab' (slashes are encoded for you).","maxLength":200,"title":"Project","type":"string"},"group_key":{"description":"Key of the resource group, for example 'production' (from list_resource_groups).","maxLength":200,"title":"Group Key","type":"string"}},"required":["project","group_key"],"title":"list_resource_group_upcoming_jobsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_ci_templates":{"post":{"operationId":"list_ci_templates","summary":"List GitLab's built-in .gitlab-ci.yml templates by key and name (for example Ruby, Python, Docker). Use for \"Which built","description":"List GitLab's built-in .gitlab-ci.yml templates by key and name (for example Ruby, Python, Docker). Use for \"Which built-in GitLab CI templates exist\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"per_page":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":100,"description":"How many results to return (1 to 100).","title":"Per Page"},"page":{"anyOf":[{"maximum":10000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"}},"title":"list_ci_templatesArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_ci_template":{"post":{"operationId":"get_ci_template","summary":"Get the text of one built-in .gitlab-ci.yml template by its key. Use for \"Show GitLab's built-in CI template for Ruby\".","description":"Get the text of one built-in .gitlab-ci.yml template by its key. Use for \"Show GitLab's built-in CI template for Ruby\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"template_key":{"description":"Template key as listed by list_ci_templates, for example 'Ruby' or 'Python'.","maxLength":200,"title":"Template Key","type":"string"}},"required":["template_key"],"title":"get_ci_templateArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}}}}