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

codeScanningGetCodeqlDatabase

Get a CodeQL database for a repository

Details

  • Method: GET
  • Path: /repos/{owner}/{repo}/code-scanning/codeql/databases/{language}
  • Operation ID: code-scanning/get-codeql-database

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"
  },
  "language": {
    "description": "The language of the CodeQL database.",
    "required": true,
    "location": "path",
    "type": "string"
  }
}

Response Schema

{
  "title": "CodeQL Database",
  "description": "A CodeQL database.",
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "description": "The ID of the CodeQL database."
    },
    "name": {
      "type": "string",
      "description": "The name of the CodeQL database."
    },
    "language": {
      "type": "string",
      "description": "The language of the CodeQL database."
    },
    "uploader": {
      "title": "Simple User",
      "description": "A GitHub user.",
      "type": "object",
      "properties": {
        "name": {
          "nullable": true,
          "type": "string"
        },
        "email": {
          "nullable": true,
          "type": "string"
        },
        "login": {
          "type": "string",
          "example": "octocat"
        },
        "id": {
          "type": "integer",
          "format": "int64",
          "example": 1
        },
        "node_id": {
          "type": "string",
          "example": "MDQ6VXNlcjE="
        },
        "avatar_url": {
          "type": "string",
          "format": "uri",
          "example": "https://github.com/images/error/octocat_happy.gif"
        },
        "gravatar_id": {
          "type": "string",
          "example": "41d064eb2195891e12d0413f63227ea7",
          "nullable": true
        },
        "url": {
          "type": "string",
          "format": "uri",
          "example": "https://api.github.com/users/octocat"
        },
        "html_url": {
          "type": "string",
          "format": "uri",
          "example": "https://github.com/octocat"
        },
        "followers_url": {
          "type": "string",
          "format": "uri",
          "example": "https://api.github.com/users/octocat/followers"
        },
        "following_url": {
          "type": "string",
          "example": "https://api.github.com/users/octocat/following{/other_user}"
        },
        "gists_url": {
          "type": "string",
          "example": "https://api.github.com/users/octocat/gists{/gist_id}"
        },
        "starred_url": {
          "type": "string",
          "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}"
        },
        "subscriptions_url": {
          "type": "string",
          "format": "uri",
          "example": "https://api.github.com/users/octocat/subscriptions"
        },
        "organizations_url": {
          "type": "string",
          "format": "uri",
          "example": "https://api.github.com/users/octocat/orgs"
        },
        "repos_url": {
          "type": "string",
          "format": "uri",
          "example": "https://api.github.com/users/octocat/repos"
        },
        "events_url": {
          "type": "string",
          "example": "https://api.github.com/users/octocat/events{/privacy}"
        },
        "received_events_url": {
          "type": "string",
          "format": "uri",
          "example": "https://api.github.com/users/octocat/received_events"
        },
        "type": {
          "type": "string",
          "example": "User"
        },
        "site_admin": {
          "type": "boolean"
        },
        "starred_at": {
          "type": "string",
          "example": "\"2020-07-09T00:17:55Z\""
        },
        "user_view_type": {
          "type": "string",
          "example": "public"
        }
      },
      "required": [
        "avatar_url",
        "events_url",
        "followers_url",
        "following_url",
        "gists_url",
        "gravatar_id",
        "html_url",
        "id",
        "node_id",
        "login",
        "organizations_url",
        "received_events_url",
        "repos_url",
        "site_admin",
        "starred_url",
        "subscriptions_url",
        "type",
        "url"
      ]
    },
    "content_type": {
      "type": "string",
      "description": "The MIME type of the CodeQL database file."
    },
    "size": {
      "type": "integer",
      "description": "The size of the CodeQL database file in bytes."
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "The date and time at which the CodeQL database was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ."
    },
    "updated_at": {
      "type": "string",
      "format": "date-time",
      "description": "The date and time at which the CodeQL database was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ."
    },
    "url": {
      "type": "string",
      "format": "uri",
      "description": "The URL at which to download the CodeQL database. The `Accept` header must be set to the value of the `content_type` property."
    },
    "commit_oid": {
      "type": "string",
      "description": "The commit SHA of the repository at the time the CodeQL database was created.",
      "nullable": true
    }
  },
  "required": [
    "id",
    "name",
    "language",
    "uploader",
    "content_type",
    "size",
    "created_at",
    "updated_at",
    "url"
  ]
}

Usage

from ocp_agent import OCPAgent

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

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