Open Context Protocol is live! 🚀 Read the launch post

matchIssues

Check issues against JQL

Details

  • Method: POST
  • Path: /rest/api/3/jql/match
  • Operation ID: matchIssues

Parameters

{
  "issueIds": {
    "description": "A list of issue IDs.",
    "required": true,
    "location": "body",
    "type": "array"
  },
  "jqls": {
    "description": "A list of JQL queries.",
    "required": true,
    "location": "body",
    "type": "array"
  }
}

Response Schema

{
  "additionalProperties": false,
  "description": "A list of matched issues or errors for each JQL query, in the order the JQL queries were passed.",
  "properties": {
    "matches": {
      "items": {
        "additionalProperties": false,
        "description": "A list of the issues matched to a JQL query or details of errors encountered during matching.",
        "properties": {
          "errors": {
            "description": "A list of errors.",
            "items": {
              "description": "A list of errors.",
              "type": "string"
            },
            "type": "array",
            "uniqueItems": true
          },
          "matchedIssues": {
            "description": "A list of issue IDs.",
            "items": {
              "description": "A list of issue IDs.",
              "format": "int64",
              "type": "integer"
            },
            "type": "array",
            "uniqueItems": true
          }
        },
        "required": [
          "errors",
          "matchedIssues"
        ],
        "type": "object"
      },
      "type": "array"
    }
  },
  "required": [
    "matches"
  ],
  "type": "object"
}

Usage

from ocp_agent import OCPAgent

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

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