{"openapi":"3.1.0","info":{"title":"Jira Service Management (BYOK) API","version":"0.1.0","description":"Jira Service Management (BYOK) lets an AI assistant read your own Jira Service Management data through the Jira Service Management API with a key you supply (Atlassian account email). Read-only: 10 tools (get_info, list_service_desks, list_queues, list_queue_requests, list_customer_requests, get_customer_request, list_request_comments, list_request_slas, list_request_types,...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-jira-service-management.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-jira-service-management/docs"},"termsOfService":"https://connectorbay.com/byok-jira-service-management/terms"},"servers":[{"url":"https://byok-jira-service-management.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-jira-service-management/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/get_info":{"post":{"operationId":"get_info","summary":"Show the version and build of the Jira Service Management instance and whether it is licensed for use. Use for \"Which Ji","description":"Show the version and build of the Jira Service Management instance and whether it is licensed for use. Use for \"Which Jira Service Management version does my site run\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"site":{"description":"Your Atlassian site name: the part before .atlassian.net, for example 'mycompany' for mycompany.atlassian.net.","maxLength":200,"pattern":"^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$","title":"Site","type":"string"}},"required":["site"],"title":"get_infoArguments","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_service_desks":{"post":{"operationId":"list_service_desks","summary":"List the service desks (help portals) you can access with project key, name and type. Use for \"Which service desks do we","description":"List the service desks (help portals) you can access with project key, name and type. Use for \"Which service desks do we have in Jira Service Management\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"site":{"description":"Your Atlassian site name: the part before .atlassian.net, for example 'mycompany' for mycompany.atlassian.net.","maxLength":200,"pattern":"^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$","title":"Site","type":"string"},"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":25,"description":"How many items to return (1 to 100, default 25).","title":"Limit"},"start":{"anyOf":[{"maximum":100000,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"Index of the first item, starting at 0, for paging.","title":"Start"}},"required":["site"],"title":"list_service_desksArguments","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_queues":{"post":{"operationId":"list_queues","summary":"List the agent queues of one service desk with their JQL; set include_count for the number of requests in each queue. Us","description":"List the agent queues of one service desk with their JQL; set include_count for the number of requests in each queue. Use for \"What queues does service desk 1 have and how many requests are in each\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"site":{"description":"Your Atlassian site name: the part before .atlassian.net, for example 'mycompany' for mycompany.atlassian.net.","maxLength":200,"pattern":"^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$","title":"Site","type":"string"},"service_desk_id":{"description":"Service desk id (from list_service_desks) or its project key.","maxLength":40,"title":"Service Desk Id","type":"string"},"include_count":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":false,"description":"True to include the request count of every queue (slower).","title":"Include Count"},"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":25,"description":"How many items to return (1 to 100, default 25).","title":"Limit"},"start":{"anyOf":[{"maximum":100000,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"Index of the first item, starting at 0, for paging.","title":"Start"}},"required":["site","service_desk_id"],"title":"list_queuesArguments","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_queue_requests":{"post":{"operationId":"list_queue_requests","summary":"List the requests inside one queue of a service desk; only the fields the queue is configured to show are returned. Use ","description":"List the requests inside one queue of a service desk; only the fields the queue is configured to show are returned. Use for \"Show me the requests in queue 10 of service desk 1\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"site":{"description":"Your Atlassian site name: the part before .atlassian.net, for example 'mycompany' for mycompany.atlassian.net.","maxLength":200,"pattern":"^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$","title":"Site","type":"string"},"service_desk_id":{"description":"Service desk id (from list_service_desks) or its project key.","maxLength":40,"title":"Service Desk Id","type":"string"},"queue_id":{"description":"Queue id, taken from list_queues.","maximum":2147483647,"minimum":0,"title":"Queue Id","type":"integer"},"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":25,"description":"How many items to return (1 to 100, default 25).","title":"Limit"},"start":{"anyOf":[{"maximum":100000,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"Index of the first item, starting at 0, for paging.","title":"Start"}},"required":["site","service_desk_id","queue_id"],"title":"list_queue_requestsArguments","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_customer_requests":{"post":{"operationId":"list_customer_requests","summary":"List customer requests visible to the key's user, most recent activity first, filtered by service desk, request type, st","description":"List customer requests visible to the key's user, most recent activity first, filtered by service desk, request type, status or summary text. Use for \"What open customer requests does service desk 1 have\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"site":{"description":"Your Atlassian site name: the part before .atlassian.net, for example 'mycompany' for mycompany.atlassian.net.","maxLength":200,"pattern":"^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$","title":"Site","type":"string"},"service_desk_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"default":null,"description":"Only requests of this service desk id.","title":"Service Desk Id"},"request_type_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"default":null,"description":"Only requests of this request type id; needs service_desk_id.","title":"Request Type Id"},"request_status":{"anyOf":[{"enum":["OPEN_REQUESTS","CLOSED_REQUESTS","ALL_REQUESTS"],"type":"string"},{"type":"null"}],"default":null,"description":"OPEN_REQUESTS, CLOSED_REQUESTS or ALL_REQUESTS.","title":"Request Status"},"search_term":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Text matched against the request summary.","title":"Search Term"},"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":25,"description":"How many items to return (1 to 100, default 25).","title":"Limit"},"start":{"anyOf":[{"maximum":100000,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"Index of the first item, starting at 0, for paging.","title":"Start"}},"required":["site"],"title":"list_customer_requestsArguments","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_customer_request":{"post":{"operationId":"get_customer_request","summary":"Get one customer request by issue key or id with its status, request type, reporter and creation date. Use for \"Show me ","description":"Get one customer request by issue key or id with its status, request type, reporter and creation date. Use for \"Show me service desk request HELP-42\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"site":{"description":"Your Atlassian site name: the part before .atlassian.net, for example 'mycompany' for mycompany.atlassian.net.","maxLength":200,"pattern":"^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$","title":"Site","type":"string"},"issue_id_or_key":{"description":"Issue key such as HELP-42, or the numeric issue id.","maxLength":60,"title":"Issue Id Or Key","type":"string"}},"required":["site","issue_id_or_key"],"title":"get_customer_requestArguments","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_request_comments":{"post":{"operationId":"list_request_comments","summary":"List the comments of a customer request (public and internal) with author, text and time. Use for \"What has been said on","description":"List the comments of a customer request (public and internal) with author, text and time. Use for \"What has been said on request HELP-42\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"site":{"description":"Your Atlassian site name: the part before .atlassian.net, for example 'mycompany' for mycompany.atlassian.net.","maxLength":200,"pattern":"^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$","title":"Site","type":"string"},"issue_id_or_key":{"description":"Issue key such as HELP-42, or the numeric issue id.","maxLength":60,"title":"Issue Id Or Key","type":"string"},"public":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":true,"description":"False to hide public comments.","title":"Public"},"internal":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":true,"description":"False to hide internal comments.","title":"Internal"},"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":25,"description":"How many items to return (1 to 100, default 25).","title":"Limit"},"start":{"anyOf":[{"maximum":100000,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"Index of the first item, starting at 0, for paging.","title":"Start"}},"required":["site","issue_id_or_key"],"title":"list_request_commentsArguments","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_request_slas":{"post":{"operationId":"list_request_slas","summary":"List the SLA timers of a customer request with ongoing and completed cycles and whether they breached. Use for \"Is reque","description":"List the SLA timers of a customer request with ongoing and completed cycles and whether they breached. Use for \"Is request HELP-42 within its SLA\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"site":{"description":"Your Atlassian site name: the part before .atlassian.net, for example 'mycompany' for mycompany.atlassian.net.","maxLength":200,"pattern":"^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$","title":"Site","type":"string"},"issue_id_or_key":{"description":"Issue key such as HELP-42, or the numeric issue id.","maxLength":60,"title":"Issue Id Or Key","type":"string"},"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":25,"description":"How many items to return (1 to 100, default 25).","title":"Limit"},"start":{"anyOf":[{"maximum":100000,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"Index of the first item, starting at 0, for paging.","title":"Start"}},"required":["site","issue_id_or_key"],"title":"list_request_slasArguments","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_request_types":{"post":{"operationId":"list_request_types","summary":"List the request types (the forms customers can raise) of a service desk with name, description and group ids. Use for \"","description":"List the request types (the forms customers can raise) of a service desk with name, description and group ids. Use for \"What kinds of requests can customers raise in service desk 1\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"site":{"description":"Your Atlassian site name: the part before .atlassian.net, for example 'mycompany' for mycompany.atlassian.net.","maxLength":200,"pattern":"^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$","title":"Site","type":"string"},"service_desk_id":{"description":"Service desk id (from list_service_desks) or its project key.","maxLength":40,"title":"Service Desk Id","type":"string"},"search_query":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Text to filter request types by name.","title":"Search Query"},"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":25,"description":"How many items to return (1 to 100, default 25).","title":"Limit"},"start":{"anyOf":[{"maximum":100000,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"Index of the first item, starting at 0, for paging.","title":"Start"}},"required":["site","service_desk_id"],"title":"list_request_typesArguments","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/search_knowledge_base":{"post":{"operationId":"search_knowledge_base","summary":"Search the knowledge base linked to a service desk; returns title and excerpt of matching articles. Use for \"Find help a","description":"Search the knowledge base linked to a service desk; returns title and excerpt of matching articles. Use for \"Find help articles about password reset in service desk 1\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"site":{"description":"Your Atlassian site name: the part before .atlassian.net, for example 'mycompany' for mycompany.atlassian.net.","maxLength":200,"pattern":"^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$","title":"Site","type":"string"},"service_desk_id":{"description":"Service desk id (from list_service_desks) or its project key.","maxLength":40,"title":"Service Desk Id","type":"string"},"query":{"description":"Search text (required).","maxLength":200,"title":"Query","type":"string"},"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":25,"description":"How many items to return (1 to 100, default 25).","title":"Limit"},"start":{"anyOf":[{"maximum":100000,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"Index of the first item, starting at 0, for paging.","title":"Start"}},"required":["site","service_desk_id","query"],"title":"search_knowledge_baseArguments","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}}}}