{"openapi":"3.1.0","info":{"title":"GitHub Checks (BYOK) API","version":"0.1.0","description":"GitHub Checks (BYOK) lets an AI assistant read your own GitHub Checks data through the GitHub Checks API with a key you supply (GitHub personal access token (repo scope for private repositories)). Read-only: 8 tools (list_check_runs_for_ref, list_check_suites_for_ref, get_combined_status, list_commit_statuses, get_check_run, list_check_run_annotations, get_check_suite, list_check_runs_in_suite)....\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-github-checks.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-github-checks/docs"},"termsOfService":"https://connectorbay.com/byok-github-checks/terms"},"servers":[{"url":"https://byok-github-checks.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-github-checks/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_check_runs_for_ref":{"post":{"operationId":"list_check_runs_for_ref","summary":"List the check runs (CI jobs, linters, scanners) reported for a commit, branch or tag with status, conclusion, app and t","description":"List the check runs (CI jobs, linters, scanners) reported for a commit, branch or tag with status, conclusion, app and timing. Use for \"Which CI checks passed on the main branch of octocat/Hello-World\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"owner":{"description":"Account that owns the repository (user or organization login), for example 'octocat'.","maxLength":200,"title":"Owner","type":"string"},"repo":{"description":"Repository name without the owner, for example 'Hello-World'.","maxLength":200,"title":"Repo","type":"string"},"ref":{"description":"Commit SHA, or a plain branch or tag name such as 'main' (names containing a slash may not resolve; prefer the SHA).","maxLength":200,"title":"Ref","type":"string"},"check_name":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Only runs with exactly this check name.","title":"Check Name"},"status":{"anyOf":[{"enum":["queued","in_progress","completed"],"type":"string"},{"type":"null"}],"default":null,"description":"Only runs with this status.","title":"Status"},"filter":{"anyOf":[{"enum":["latest","all"],"type":"string"},{"type":"null"}],"default":"latest","description":"latest (default) returns the newest run per check name; all returns every run.","title":"Filter"},"per_page":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":30,"description":"How many results to return (1 to 100, default 30).","title":"Per Page"},"page":{"anyOf":[{"maximum":10000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"}},"required":["owner","repo","ref"],"title":"list_check_runs_for_refArguments","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_check_suites_for_ref":{"post":{"operationId":"list_check_suites_for_ref","summary":"List the check suites (one per app that reported checks) for a commit, branch or tag with status, conclusion and counts.","description":"List the check suites (one per app that reported checks) for a commit, branch or tag with status, conclusion and counts. Use for \"Which apps ran check suites on commit ce58745 of octocat/Hello-World\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"owner":{"description":"Account that owns the repository (user or organization login), for example 'octocat'.","maxLength":200,"title":"Owner","type":"string"},"repo":{"description":"Repository name without the owner, for example 'Hello-World'.","maxLength":200,"title":"Repo","type":"string"},"ref":{"description":"Commit SHA, or a plain branch or tag name such as 'main' (names containing a slash may not resolve; prefer the SHA).","maxLength":200,"title":"Ref","type":"string"},"check_name":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Only suites that contain a run with this name.","title":"Check Name"},"per_page":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":30,"description":"How many results to return (1 to 100, default 30).","title":"Per Page"},"page":{"anyOf":[{"maximum":10000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"}},"required":["owner","repo","ref"],"title":"list_check_suites_for_refArguments","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_combined_status":{"post":{"operationId":"get_combined_status","summary":"Get the combined commit status for a ref (success, failure, pending or error) plus the individual status contexts behind","description":"Get the combined commit status for a ref (success, failure, pending or error) plus the individual status contexts behind it. Use for \"What is the combined commit status of main on octocat/Hello-World\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"owner":{"description":"Account that owns the repository (user or organization login), for example 'octocat'.","maxLength":200,"title":"Owner","type":"string"},"repo":{"description":"Repository name without the owner, for example 'Hello-World'.","maxLength":200,"title":"Repo","type":"string"},"ref":{"description":"Commit SHA, or a plain branch or tag name such as 'main' (names containing a slash may not resolve; prefer the SHA).","maxLength":200,"title":"Ref","type":"string"},"per_page":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":30,"description":"How many results to return (1 to 100, default 30).","title":"Per Page"},"page":{"anyOf":[{"maximum":10000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"}},"required":["owner","repo","ref"],"title":"get_combined_statusArguments","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_commit_statuses":{"post":{"operationId":"list_commit_statuses","summary":"List every commit status posted for a ref, newest first, with context, state, description and target URL. Use for \"Show ","description":"List every commit status posted for a ref, newest first, with context, state, description and target URL. Use for \"Show the history of commit statuses for commit ce58745 of octocat/Hello-World\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"owner":{"description":"Account that owns the repository (user or organization login), for example 'octocat'.","maxLength":200,"title":"Owner","type":"string"},"repo":{"description":"Repository name without the owner, for example 'Hello-World'.","maxLength":200,"title":"Repo","type":"string"},"ref":{"description":"Commit SHA, or a plain branch or tag name such as 'main' (names containing a slash may not resolve; prefer the SHA).","maxLength":200,"title":"Ref","type":"string"},"per_page":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":30,"description":"How many results to return (1 to 100, default 30).","title":"Per Page"},"page":{"anyOf":[{"maximum":10000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"}},"required":["owner","repo","ref"],"title":"list_commit_statusesArguments","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_check_run":{"post":{"operationId":"get_check_run","summary":"Get one check run by its numeric ID: name, status, conclusion, timing, output title and summary, and annotation count. U","description":"Get one check run by its numeric ID: name, status, conclusion, timing, output title and summary, and annotation count. Use for \"Give me the details of check run 4 on octocat/Hello-World\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"owner":{"description":"Account that owns the repository (user or organization login), for example 'octocat'.","maxLength":200,"title":"Owner","type":"string"},"repo":{"description":"Repository name without the owner, for example 'Hello-World'.","maxLength":200,"title":"Repo","type":"string"},"check_run_id":{"description":"Numeric ID of the check run (from list_check_runs_for_ref).","title":"Check Run Id","type":"integer"}},"required":["owner","repo","check_run_id"],"title":"get_check_runArguments","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_check_run_annotations":{"post":{"operationId":"list_check_run_annotations","summary":"List the annotations (file, line range, level, title, message) a check run attached to code, for example linter warnings","description":"List the annotations (file, line range, level, title, message) a check run attached to code, for example linter warnings. Use for \"What annotations did check run 4 add on octocat/Hello-World\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"owner":{"description":"Account that owns the repository (user or organization login), for example 'octocat'.","maxLength":200,"title":"Owner","type":"string"},"repo":{"description":"Repository name without the owner, for example 'Hello-World'.","maxLength":200,"title":"Repo","type":"string"},"check_run_id":{"description":"Numeric ID of the check run.","title":"Check Run Id","type":"integer"},"per_page":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":30,"description":"How many results to return (1 to 100, default 30).","title":"Per Page"},"page":{"anyOf":[{"maximum":10000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"}},"required":["owner","repo","check_run_id"],"title":"list_check_run_annotationsArguments","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_check_suite":{"post":{"operationId":"get_check_suite","summary":"Get one check suite by its numeric ID: branch, SHA, status, conclusion, creating app and the run count. Use for \"Describ","description":"Get one check suite by its numeric ID: branch, SHA, status, conclusion, creating app and the run count. Use for \"Describe check suite 5 on octocat/Hello-World\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"owner":{"description":"Account that owns the repository (user or organization login), for example 'octocat'.","maxLength":200,"title":"Owner","type":"string"},"repo":{"description":"Repository name without the owner, for example 'Hello-World'.","maxLength":200,"title":"Repo","type":"string"},"check_suite_id":{"description":"Numeric ID of the check suite (from list_check_suites_for_ref).","title":"Check Suite Id","type":"integer"}},"required":["owner","repo","check_suite_id"],"title":"get_check_suiteArguments","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_check_runs_in_suite":{"post":{"operationId":"list_check_runs_in_suite","summary":"List the check runs that belong to one check suite with status, conclusion and timing. Use for \"List the runs inside che","description":"List the check runs that belong to one check suite with status, conclusion and timing. Use for \"List the runs inside check suite 5 on octocat/Hello-World\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"owner":{"description":"Account that owns the repository (user or organization login), for example 'octocat'.","maxLength":200,"title":"Owner","type":"string"},"repo":{"description":"Repository name without the owner, for example 'Hello-World'.","maxLength":200,"title":"Repo","type":"string"},"check_suite_id":{"description":"Numeric ID of the check suite.","title":"Check Suite Id","type":"integer"},"check_name":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Only runs with exactly this check name.","title":"Check Name"},"status":{"anyOf":[{"enum":["queued","in_progress","completed"],"type":"string"},{"type":"null"}],"default":null,"description":"Only runs with this status.","title":"Status"},"filter":{"anyOf":[{"enum":["latest","all"],"type":"string"},{"type":"null"}],"default":"latest","description":"latest (default) returns the newest run per check name; all returns every run.","title":"Filter"},"per_page":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":30,"description":"How many results to return (1 to 100, default 30).","title":"Per Page"},"page":{"anyOf":[{"maximum":10000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"}},"required":["owner","repo","check_suite_id"],"title":"list_check_runs_in_suiteArguments","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}}}}