JiraClient

Attributes

Sites module-attribute

Sites = List[Dict[str, Any]]

UserList module-attribute

UserList = List[Dict[str, Any]]

IssueTypes module-attribute

IssueTypes = List[Dict[str, Any]]

ProjectArray module-attribute

ProjectArray = List[Dict[str, Any]]

FilterArray module-attribute

FilterArray = List[Dict[str, Any]]

StatusList module-attribute

StatusList = List[Dict[str, Any]]

PriorityList module-attribute

PriorityList = List[Dict[str, Any]]

TRIGGER_OPERATIONS module-attribute

TRIGGER_OPERATIONS: Dict[str, Dict[str, Any]] = {'OnNewIssue_Datacenter': {'operation_id': 'OnNewIssue_Datacenter', 'path': '/{connectionId}/datacenter/new_issue_trigger/search', 'method': 'get', 'required_parameters': ['projectKey'], 'callback_payload_type': 'FullIssue'}, 'OnCloseIssue_Datacenter': {'operation_id': 'OnCloseIssue_Datacenter', 'path': '/{connectionId}/datacenter/close_issue_trigger/search', 'method': 'get', 'required_parameters': ['projectKey'], 'callback_payload_type': 'FullIssue'}, 'OnNewIssueJQL_Datacenter': {'operation_id': 'OnNewIssueJQL_Datacenter', 'path': '/{connectionId}/datacenter/new_issue_jql_trigger/search', 'method': 'get', 'required_parameters': ['jql'], 'callback_payload_type': 'FullIssue'}, 'OnCloseIssue_V2': {'operation_id': 'OnCloseIssue_V2', 'path': '/{connectionId}/v2/close_issue_trigger/search', 'method': 'get', 'required_parameters': ['projectKey'], 'callback_payload_type': 'FullIssue'}, 'OnNewIssue_V2': {'operation_id': 'OnNewIssue_V2', 'path': '/{connectionId}/v2/new_issue_trigger/search', 'method': 'get', 'required_parameters': ['projectKey'], 'callback_payload_type': 'FullIssue'}, 'OnNewIssueJQL_V2': {'operation_id': 'OnNewIssueJQL_V2', 'path': '/{connectionId}/v2/new_issue_jql_trigger/search', 'method': 'get', 'required_parameters': ['jql'], 'callback_payload_type': 'FullIssue'}}

Classes

ListIssuesResponse dataclass

ListIssuesResponse(next_page_token: Optional[str] = None, is_last: Optional[bool] = None, issues: Optional[List[FullIssue]] = None)

Response for Get list of issues

Attributes

next_page_token class-attribute instance-attribute

next_page_token: Optional[str] = field(default=None, metadata={'wire_name': 'nextPageToken'})

The token used to retrieve the next page of issues. Pass this value into the 'Next page token' input of a subsequent call to fetch the next page. Absent on the last page.

is_last class-attribute instance-attribute

is_last: Optional[bool] = field(default=None, metadata={'wire_name': 'isLast'})

Indicates whether this is the last page of results.

ListIssuesResponseDatacenter dataclass

ListIssuesResponseDatacenter(start_at: Optional[int] = None, max_results: Optional[int] = None, issues: Optional[List[FullIssue]] = None)

Response for Get list of issues (Datacenter)

Attributes

start_at class-attribute instance-attribute

start_at: Optional[int] = field(default=None, metadata={'wire_name': 'startAt'})

The index of the first item to return in a page of results

max_results class-attribute instance-attribute

max_results: Optional[int] = field(default=None, metadata={'wire_name': 'maxResults'})

The maximum number of items to return per page

ListTransitionsResponse dataclass

ListTransitionsResponse(transitions: Optional[List[Transition]] = None)

Response for Get list of Transitions

UpdateTransitionResponse dataclass

UpdateTransitionResponse(additional_properties: Dict[str, Any] = dict())

Response for Performs an issue transition

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = field(default_factory=dict)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

GetCurrentUserResponse dataclass

GetCurrentUserResponse(additional_properties: Dict[str, Any] = dict())

Response for Get current user

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = field(default_factory=dict)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

FullIssue dataclass

FullIssue(id: Optional[str] = None, key: Optional[str] = None, self: Optional[str] = None, fields: Optional[Dict[str, Any]] = None)

Response for When a new issue is created (Datacenter)

Attributes

id class-attribute instance-attribute

id: Optional[str] = None

Unique id of the issue.

key class-attribute instance-attribute

key: Optional[str] = None

Unique key of the issue.

self class-attribute instance-attribute

self: Optional[str] = None

Browse to the issue using this URL.

MCPQueryResponse dataclass

MCPQueryResponse(jsonrpc: Optional[str] = None, id: Optional[str] = None, method: Optional[str] = None, params: Optional[Dict[str, Any]] = None, result: Optional[Dict[str, Any]] = None, error: Optional[Dict[str, Any]] = None)

Response for Jira MCP Server

CommentResponse dataclass

CommentResponse(id: Optional[str] = None, body: Optional[str] = None, created: Optional[str] = None)

Response for Add comment

Attributes

id class-attribute instance-attribute

id: Optional[str] = None

Unique id of the comment.

body class-attribute instance-attribute

body: Optional[str] = None

Body of the comment.

created class-attribute instance-attribute

created: Optional[str] = None

yyyy-MM-ddTHH:mm:ss.fffZ

CancelTaskResponse dataclass

CancelTaskResponse(additional_properties: Dict[str, Any] = dict())

Response for Cancel Task

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = field(default_factory=dict)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

CreateIssueInput dataclass

CreateIssueInput(additional_properties: Dict[str, Any] = dict())

Create a new issue

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = field(default_factory=dict)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

CreateIssueResponse dataclass

CreateIssueResponse(id: Optional[str] = None, key: Optional[str] = None)

Response for Create a new issue

Attributes

id class-attribute instance-attribute

id: Optional[str] = None

Unique identifier of the issue.

key class-attribute instance-attribute

key: Optional[str] = None

Unique key of the issue.

CreateProjectInput dataclass

CreateProjectInput(key: Optional[str] = None, name: Optional[str] = None, project_type_key: Optional[str] = None, lead_account_id: Optional[str] = None, description: Optional[str] = None)

Create a new project

Attributes

key class-attribute instance-attribute

key: Optional[str] = None

The unique key, starts with a capital letter.

name class-attribute instance-attribute

name: Optional[str] = None

Title of the project.

project_type_key class-attribute instance-attribute

project_type_key: Optional[str] = field(default=None, metadata={'wire_name': 'projectTypeKey'})

Project type key.

lead_account_id class-attribute instance-attribute

lead_account_id: Optional[str] = field(default=None, metadata={'wire_name': 'leadAccountId'})

Id of Project lead.

description class-attribute instance-attribute

description: Optional[str] = None

Verbose description of the project.

CreateProjectResponse dataclass

CreateProjectResponse(id: Optional[int] = None, key: Optional[str] = None)

Response for Create a new project

Attributes

id class-attribute instance-attribute

id: Optional[int] = None

Unique id of the project.

key class-attribute instance-attribute

key: Optional[str] = None

Unique key of the project.

CreateProjectCategoryInput dataclass

CreateProjectCategoryInput(name: Optional[str] = None, description: Optional[str] = None)

Create Project Category

Attributes

name class-attribute instance-attribute

name: Optional[str] = None

Name

description class-attribute instance-attribute

description: Optional[str] = None

Description

CreateProjectCategoryResponse dataclass

CreateProjectCategoryResponse(additional_properties: Dict[str, Any] = dict())

Response for Create Project Category

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = field(default_factory=dict)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

EditIssueInput dataclass

EditIssueInput(transition: Optional[Dict[str, Any]] = None, fields: Optional[Dict[str, Any]] = None, update: Optional[Dict[str, Any]] = None, history_metadata: Optional[Dict[str, Any]] = None, properties: Optional[List[Dict[str, Any]]] = None)

Edit Issue

Attributes

transition class-attribute instance-attribute

transition: Optional[Dict[str, Any]] = None

Transition

fields class-attribute instance-attribute

fields: Optional[Dict[str, Any]] = None

List of issue screen fields to update, specifying the sub-field to update and its value for each field. This field provides a straightforward option when setting a sub-field. When multiple sub-fields or other operations are required, use update. Fields included in here cannot be included in update.

update class-attribute instance-attribute

update: Optional[Dict[str, Any]] = None

A Map containing the field field name and a list of operations to perform on the issue screen field. Note that fields included in here cannot be included in fields.

history_metadata class-attribute instance-attribute

history_metadata: Optional[Dict[str, Any]] = field(default=None, metadata={'wire_name': 'historyMetadata'})

History meta data

properties class-attribute instance-attribute

properties: Optional[List[Dict[str, Any]]] = None

Properties

EditIssueResponse dataclass

EditIssueResponse(additional_properties: Dict[str, Any] = dict())

Response for Edit Issue

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = field(default_factory=dict)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

GetTaskResponse dataclass

GetTaskResponse(additional_properties: Dict[str, Any] = dict())

Response for Get Task

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = field(default_factory=dict)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

GetUserResponse dataclass

GetUserResponse(additional_properties: Dict[str, Any] = dict())

Response for Get User

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = field(default_factory=dict)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

ListFiltersResponse dataclass

ListFiltersResponse(next_page: Optional[str] = None, values: Optional[FilterArray] = None)

Response for Get list of Filters

Attributes

next_page class-attribute instance-attribute

next_page: Optional[str] = field(default=None, metadata={'wire_name': 'nextPage'})

Next page of filters

ListProjectsResponse dataclass

ListProjectsResponse(next_page: Optional[str] = None, values: Optional[ProjectArray] = None)

Response for Get projects

Attributes

next_page class-attribute instance-attribute

next_page: Optional[str] = field(default=None, metadata={'wire_name': 'nextPage'})

Next page of projects

UpdateProjectInput dataclass

UpdateProjectInput(key: Optional[str] = None, name: Optional[str] = None, project_type_key: Optional[str] = None, project_template_key: Optional[str] = None, description: Optional[str] = None, lead: Optional[str] = None, lead_account_id: Optional[str] = None, url: Optional[str] = None, assignee_type: Optional[str] = None, avatar_id: Optional[str] = None, issue_security_scheme: Optional[str] = None, permission_scheme: Optional[str] = None, notification_scheme: Optional[str] = None, category_id: Optional[str] = None)

Update Project

Attributes

key class-attribute instance-attribute

key: Optional[str] = None

Key

name class-attribute instance-attribute

name: Optional[str] = None

Name

project_type_key class-attribute instance-attribute

project_type_key: Optional[str] = field(default=None, metadata={'wire_name': 'projectTypeKey'})

Project Type Key

project_template_key class-attribute instance-attribute

project_template_key: Optional[str] = field(default=None, metadata={'wire_name': 'projectTemplateKey'})

Project Template Key

description class-attribute instance-attribute

description: Optional[str] = None

Description

lead class-attribute instance-attribute

lead: Optional[str] = None

Lead

lead_account_id class-attribute instance-attribute

lead_account_id: Optional[str] = field(default=None, metadata={'wire_name': 'leadAccountId'})

Lead Account ID

url class-attribute instance-attribute

url: Optional[str] = None

URL

assignee_type class-attribute instance-attribute

assignee_type: Optional[str] = field(default=None, metadata={'wire_name': 'assigneeType'})

Assignee Type

avatar_id class-attribute instance-attribute

avatar_id: Optional[str] = field(default=None, metadata={'wire_name': 'avatarId'})

Avatar ID

issue_security_scheme class-attribute instance-attribute

issue_security_scheme: Optional[str] = field(default=None, metadata={'wire_name': 'issueSecurityScheme'})

Issue Security Scheme

permission_scheme class-attribute instance-attribute

permission_scheme: Optional[str] = field(default=None, metadata={'wire_name': 'permissionScheme'})

Permission Scheme

notification_scheme class-attribute instance-attribute

notification_scheme: Optional[str] = field(default=None, metadata={'wire_name': 'notificationScheme'})

Notification Scheme

category_id class-attribute instance-attribute

category_id: Optional[str] = field(default=None, metadata={'wire_name': 'categoryId'})

Category ID

UpdateProjectResponse dataclass

UpdateProjectResponse(additional_properties: Dict[str, Any] = dict())

Response for Update Project

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = field(default_factory=dict)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

Project dataclass

Project(id: Optional[str] = None, key: Optional[str] = None, name: Optional[str] = None, project_type_key: Optional[str] = None)

Definition: Project

Attributes

id class-attribute instance-attribute

id: Optional[str] = None

The unique Id of the project.

key class-attribute instance-attribute

key: Optional[str] = None

The unique key of the project.

name class-attribute instance-attribute

name: Optional[str] = None

Name of the project.

project_type_key class-attribute instance-attribute

project_type_key: Optional[str] = field(default=None, metadata={'wire_name': 'projectTypeKey'})

The unique key of the project type.

PartialIssue dataclass

PartialIssue(id: Optional[str] = None, key: Optional[str] = None, fields: Optional[Dict[str, Any]] = None)

Definition: PartialIssue

Attributes

id class-attribute instance-attribute

id: Optional[str] = None

The unique Id of the Issue.

key class-attribute instance-attribute

key: Optional[str] = None

The unique key of the issue.

Creator dataclass

Creator(account_id: Optional[str] = None, key: Optional[str] = None, email_address: Optional[str] = None, display_name: Optional[str] = None)

Definition: Creator

Attributes

account_id class-attribute instance-attribute

account_id: Optional[str] = field(default=None, metadata={'wire_name': 'accountId'})

Person who created the issue.

key class-attribute instance-attribute

key: Optional[str] = None

Unique key of the person who created the issue.

email_address class-attribute instance-attribute

email_address: Optional[str] = field(default=None, metadata={'wire_name': 'emailAddress'})

Email of the person who created the issue.

display_name class-attribute instance-attribute

display_name: Optional[str] = field(default=None, metadata={'wire_name': 'displayName'})

Display name of the person who created the issue.

Assignee dataclass

Assignee(account_id: Optional[str] = None, key: Optional[str] = None, email_address: Optional[str] = None, display_name: Optional[str] = None)

Definition: Assignee

Attributes

account_id class-attribute instance-attribute

account_id: Optional[str] = field(default=None, metadata={'wire_name': 'accountId'})

Person whom the issue is assigned to.

key class-attribute instance-attribute

key: Optional[str] = None

Unique key of the person whom the issue is assigned to.

email_address class-attribute instance-attribute

email_address: Optional[str] = field(default=None, metadata={'wire_name': 'emailAddress'})

Email of the person whom the issue is assigned to.

display_name class-attribute instance-attribute

display_name: Optional[str] = field(default=None, metadata={'wire_name': 'displayName'})

Display name of the person whom the issue is assigned to.

User dataclass

User(account_id: Optional[str] = None, key: Optional[str] = None, email_address: Optional[str] = None, display_name: Optional[str] = None)

Definition: User

Attributes

account_id class-attribute instance-attribute

account_id: Optional[str] = field(default=None, metadata={'wire_name': 'accountId'})

Id of the Jira user.

key class-attribute instance-attribute

key: Optional[str] = None

Unique key of the Jira user.

email_address class-attribute instance-attribute

email_address: Optional[str] = field(default=None, metadata={'wire_name': 'emailAddress'})

Email of the Jira user.

display_name class-attribute instance-attribute

display_name: Optional[str] = field(default=None, metadata={'wire_name': 'displayName'})

Display name of the Jira user.

Reporter dataclass

Reporter(account_id: Optional[str] = None, key: Optional[str] = None, email_address: Optional[str] = None, display_name: Optional[str] = None)

Definition: Reporter

Attributes

account_id class-attribute instance-attribute

account_id: Optional[str] = field(default=None, metadata={'wire_name': 'AccountId'})

Person who reported the issue.

key class-attribute instance-attribute

key: Optional[str] = None

Unique key of the person who reported the issue.

email_address class-attribute instance-attribute

email_address: Optional[str] = field(default=None, metadata={'wire_name': 'emailAddress'})

Email of the person who reported the issue.

display_name class-attribute instance-attribute

display_name: Optional[str] = field(default=None, metadata={'wire_name': 'displayName'})

Display name of the person who reported the issue.

CreateIssueRequest dataclass

CreateIssueRequest(fields: Optional[Dict[str, Any]] = None)

Definition: CreateIssueRequest

UpdateIssueRequest dataclass

UpdateIssueRequest(fields: Optional[Dict[str, Any]] = None)

Definition: UpdateIssueRequest

Comment dataclass

Comment(body: Optional[str] = None)

Definition: Comment

Attributes

body class-attribute instance-attribute

body: Optional[str] = None

Body of the comment.

Transition dataclass

Transition(id: Optional[str] = None, name: Optional[str] = None, to: Optional[TransitionStatus] = None, fields: Optional[Dict[str, Any]] = None)

Definition: Transition

Attributes

id class-attribute instance-attribute

id: Optional[str] = None

ID of the transition

name class-attribute instance-attribute

name: Optional[str] = None

Name of the transition

fields class-attribute instance-attribute

fields: Optional[Dict[str, Any]] = None

Fields required for this transition

TransitionStatus dataclass

TransitionStatus(id: Optional[str] = None, name: Optional[str] = None)

Definition: TransitionStatus

Attributes

id class-attribute instance-attribute

id: Optional[str] = None

ID of the status

name class-attribute instance-attribute

name: Optional[str] = None

Name of the status

TransitionInput dataclass

TransitionInput(fields: Optional[Dict[str, Any]] = None, history_metadata: Optional[Dict[str, Any]] = None, transition: Optional[Dict[str, Any]] = None, update: Optional[Dict[str, Any]] = None)

Definition: TransitionInput

MCPQueryRequest dataclass

MCPQueryRequest(jsonrpc: Optional[str] = None, id: Optional[str] = None, method: Optional[str] = None, params: Optional[Dict[str, Any]] = None, result: Optional[Dict[str, Any]] = None, error: Optional[Dict[str, Any]] = None, callback_endpoint: Optional[str] = None)

Definition: MCPQueryRequest

JiraClient

JiraClient(connection_runtime_url: str, token_provider: Optional[TokenProvider] = None, options: Optional[ConnectorClientOptions] = None)

Bases: ConnectorClientBase

Typed client for jira connector.

Initialize a JiraClient.

Parameters:

Name	Type	Description	Default
connection_runtime_url	str	The connection runtime URL from Azure Portal.	required
token_provider	Optional[TokenProvider]	Optional token provider. Defaults to ManagedIdentityTokenProvider.	None
options	Optional[ConnectorClientOptions]	Optional connector client options.	None

Methods:

list_resources_async async

list_resources_async() -> dict[str, Any] | None

Get list of Resources

This operation returns a list of resources accessible to user.

list_issues_async async

list_issues_async(jql: Optional[str] = None, next_page_token: Optional[str] = None) -> dict[str, Any] | None

Get list of issues

This operation returns a list of issues using JQL.

list_issues_datacenter_async async

list_issues_datacenter_async() -> dict[str, Any] | None

Get list of issues (Datacenter)

This operation returns a list of issues using JQL.

list_transitions_async async

list_transitions_async(issue_id_or_key: str) -> dict[str, Any] | None

Get list of Transitions

Returns a list of the transitions possible for this issue by the current user

update_transition_async async

update_transition_async(input: TransitionInput, issue_id_or_key: str) -> dict[str, Any] | None

Performs an issue transition

Transitions an issue to a new status.

get_current_user_async async

get_current_user_async(expand: Optional[str] = None) -> dict[str, Any] | None

Get current user

This operation returns details for the current user

mcp_jira_issue_management_async async

mcp_jira_issue_management_async(input: MCPQueryRequest, session_id: Optional[str] = None) -> dict[str, Any] | None

Jira MCP Server

Jira MCP Server

add_comment_async async

add_comment_async(input: Comment, issue_key: str) -> dict[str, Any] | None

Add comment

This operation is used to add a comment to an existing Jira issue.

cancel_task_async async

cancel_task_async(task_id: str) -> dict[str, Any] | None

Cancel Task

Cancels a task. Permissions required: either of: Administer Jira or Creator of the task.

create_issue_async async

create_issue_async(input: CreateIssueInput, project_key: str, issue_type_ids: str) -> dict[str, Any] | None

Create a new issue

This operation is used to create a new issue.

create_project_async async

create_project_async(input: CreateProjectInput) -> dict[str, Any] | None

Create a new project

This operation is used to create a new Jira project.

create_project_category_async async

create_project_category_async(input: CreateProjectCategoryInput) -> dict[str, Any] | None

Create Project Category

Creates a project category. Permissions required: Administer Jira (global permissions)

delete_project_async async

delete_project_async(project_id_or_key: str, enable_undo: Optional[bool] = None) -> None

Delete Project

Deletes a project. Permissions required: Administer Jira (global permissions)

edit_issue_async async

edit_issue_async(input: EditIssueInput, issue_id_or_key: str, notify_users: Optional[bool] = None, override_screen_security: Optional[bool] = None, override_editable_flag: Optional[bool] = None) -> dict[str, Any] | None

Edit Issue

Edits an issue. A transition may be applied and issue properties updated as part of the edit. The edits to the issue's fields are defined using update and fields.

get_all_project_categories_async async

get_all_project_categories_async() -> dict[str, Any] | None

Get All Project Categories

Returns all project categories.

get_issue_async async

get_issue_async(issue_key: str) -> dict[str, Any] | None

Get issue by key

This operation is used to retrieve the issue object for a given issue Key.

get_task_async async

get_task_async(task_id: str) -> dict[str, Any] | None

Get Task

Returns the status of a long-running asynchronous task. When a task has finished, this operation returns the JSON blob applicable to the task.

get_user_async async

get_user_async(account_id: str, expand: Optional[str] = None) -> dict[str, Any] | None

Get User

Returns a user. Permissions required: Browse users and groups.

list_filters_async async

list_filters_async() -> dict[str, Any] | None

Get list of Filters

This operation returns a list of Filters accessible to user.

list_projects_async async

list_projects_async() -> dict[str, Any] | None

Get projects

This operation is used to retrieve a list of projects for your Jira instance.

list_project_users_async async

list_project_users_async(project_key: str) -> dict[str, Any] | None

List users by project

This operation is used to retrieve a list of all users associated with a project.

remove_project_category_async async

remove_project_category_async(id: int) -> None

Remove Project Category

Deletes a project category. Permissions required: Administer Jira (global permissions)

update_project_async async

update_project_async(input: UpdateProjectInput, project_id_or_key: str) -> dict[str, Any] | None

Update Project

Updates the project details of a project.

list_issue_types_async async

list_issue_types_async(project_key: str) -> dict[str, Any] | None

Get issue types

This operation is used to retrieve a list of issue types for a given project.

list_issue_types_fields_async async

list_issue_types_fields_async(project_key: str, issuetype_ids: str) -> dict[str, Any] | None

Get issue types fields

This operation is used to retrieve a list of fields for a specific issue type.