Open Context Protocol is live! 🚀 Read the launch post
checksListAnnotations

checksListAnnotations

List check run annotations

Details

  • Method: GET
  • Path: /repos/{owner}/{repo}/check-runs/{check_run_id}/annotations
  • Operation ID: checks/list-annotations

Parameters

{
  "owner": {
    "description": "The account owner of the repository. The name is not case sensitive.",
    "required": true,
    "location": "path",
    "type": "string"
  },
  "repo": {
    "description": "The name of the repository without the `.git` extension. The name is not case sensitive.",
    "required": true,
    "location": "path",
    "type": "string"
  },
  "check_run_id": {
    "description": "The unique identifier of the check run.",
    "required": true,
    "location": "path",
    "type": "integer"
  },
  "per_page": {
    "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"",
    "required": false,
    "location": "query",
    "type": "integer"
  },
  "page": {
    "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"",
    "required": false,
    "location": "query",
    "type": "integer"
  }
}

Response Schema

{
  "type": "array",
  "items": {
    "title": "Check Annotation",
    "description": "Check Annotation",
    "type": "object",
    "properties": {
      "path": {
        "type": "string",
        "example": "README.md"
      },
      "start_line": {
        "type": "integer",
        "example": 2
      },
      "end_line": {
        "type": "integer",
        "example": 2
      },
      "start_column": {
        "type": "integer",
        "example": 5,
        "nullable": true
      },
      "end_column": {
        "type": "integer",
        "example": 10,
        "nullable": true
      },
      "annotation_level": {
        "type": "string",
        "example": "warning",
        "nullable": true
      },
      "title": {
        "type": "string",
        "example": "Spell Checker",
        "nullable": true
      },
      "message": {
        "type": "string",
        "example": "Check your spelling for 'banaas'.",
        "nullable": true
      },
      "raw_details": {
        "type": "string",
        "example": "Do you mean 'bananas' or 'banana'?",
        "nullable": true
      },
      "blob_href": {
        "type": "string"
      }
    },
    "required": [
      "path",
      "blob_href",
      "start_line",
      "end_line",
      "start_column",
      "end_column",
      "annotation_level",
      "title",
      "message",
      "raw_details"
    ]
  }
}

Usage

from ocp_agent import OCPAgent

agent = OCPAgent()
await agent.register_api('github')

# Call this tool
result = await agent.call_tool('checksListAnnotations', {
    # Add required parameters here
})