Skip to main content
Glama
yuezheng2006

Personal JIRA MCP

by yuezheng2006

getIssues

Retrieve JIRA issue details and attachments by providing an issue key to access project information and related files.

Instructions

获取JIRA问题及其附件

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
issue_keyYes

Implementation Reference

  • The @mcp.tool decorator registers the getIssues handler function, which retrieves and formats a JIRA issue including attachments.
    @mcp.tool(
        description="获取JIRA问题及其附件",
    )
    def getIssues(
        issue_key: str,
    ) -> Dict[str, Any]:
        """获取JIRA问题及其附件信息.
        
        Args:
            issue_key: JIRA问题键
        
        Returns:
            Dict[str, Any]: 问题详情及附件信息
        """
        logger.info(f"获取问题及附件: {issue_key}")
        try:
            client = get_jira_client()
            issue = client.issue(issue_key)
            
            # 使用format_issue函数来获取JSON可序列化的问题数据
            issue_data = format_issue(issue)
            
            # 确保附件列表为JSON可序列化对象
            return issue_data
        except Exception as e:
            logger.error(f"获取问题 {issue_key} 及附件失败: {str(e)}")
            return {"error": str(e)}
  • Helper function format_issue used by getIssues to convert JIRA issue object to a dictionary including attachments and other fields.
    def format_issue(issue) -> Dict[str, Any]:
        """格式化JIRA问题为JSON友好格式."""
        fields = issue.fields
        
        result = {
            "id": issue.id,
            "key": issue.key,
            "self": issue.self,
            "summary": fields.summary,
            "description": fields.description or "",
            "status": {
                "id": fields.status.id,
                "name": fields.status.name,
                "description": fields.status.description,
            },
            "project": {
                "id": fields.project.id,
                "key": fields.project.key,
                "name": fields.project.name,
            },
            "created": fields.created,
            "updated": fields.updated,
        }
        
        # 添加可选字段
        if hasattr(fields, "assignee") and fields.assignee:
            result["assignee"] = {
                "name": fields.assignee.name,
                "display_name": fields.assignee.displayName,
                "email": getattr(fields.assignee, "emailAddress", ""),
            }
        
        if hasattr(fields, "reporter") and fields.reporter:
            result["reporter"] = {
                "name": fields.reporter.name,
                "display_name": fields.reporter.displayName,
                "email": getattr(fields.reporter, "emailAddress", ""),
            }
        
        if hasattr(fields, "issuetype") and fields.issuetype:
            result["issue_type"] = {
                "id": fields.issuetype.id,
                "name": fields.issuetype.name,
                "description": fields.issuetype.description,
            }
        
        if hasattr(fields, "priority") and fields.priority:
            result["priority"] = {
                "id": fields.priority.id,
                "name": fields.priority.name,
            }
        
        if hasattr(fields, "components") and fields.components:
            result["components"] = [
                {"id": c.id, "name": c.name} for c in fields.components
            ]
        
        if hasattr(fields, "labels") and fields.labels:
            result["labels"] = fields.labels
        
        # 处理附件 - JIRA API 使用 "attachment" 字段
        if hasattr(fields, "attachment") and fields.attachment:
            result["attachments"] = [
                {
                    "id": attachment.id,
                    "filename": attachment.filename,
                    "size": attachment.size,
                    "content_type": attachment.mimeType,
                    "created": attachment.created,
                    "url": attachment.content
                }
                for attachment in fields.attachment
            ]
        
        # 获取自定义字段
        for field_name in dir(fields):
            if field_name.startswith("customfield_"):
                value = getattr(fields, field_name)
                if value is not None:
                    result[field_name] = value
        
        return result
  • Helper function to get or initialize the JIRA client instance, called within getIssues.
    def get_jira_client() -> JIRA:
        """获取JIRA客户端实例."""
        global jira_client
        if jira_client is None:
            auth = get_jira_auth()
            jira_client = JIRA(server=jira_settings.server_url, basic_auth=auth)
        return jira_client
Behavior2/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

No annotations are provided, so the description carries the full burden. It mentions retrieving issues and attachments but doesn't disclose behavioral traits like whether this is a read-only operation, if it requires authentication, what format the output returns, or any rate limits. For a tool with no annotation coverage, this leaves significant gaps in understanding its behavior.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is extremely concise with a single phrase, '获取JIRA问题及其附件', which is front-loaded and wastes no words. Every part of it directly contributes to stating the tool's purpose, making it efficiently structured.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the complexity (retrieving issues and attachments), lack of annotations, no output schema, and 0% schema description coverage, the description is incomplete. It doesn't explain return values, error handling, or how attachments are included, leaving the agent with insufficient information to use the tool effectively.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters2/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The schema description coverage is 0%, so the description must compensate. It doesn't mention the 'issue_key' parameter at all, leaving it undocumented. The description implies retrieval but provides no context on what the parameter represents or how it should be used, failing to add meaning beyond the bare schema.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose3/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description '获取JIRA问题及其附件' (Get JIRA issues and their attachments) states a clear verb ('获取' - get) and resource ('JIRA问题及其附件' - JIRA issues and attachments), but it's vague about scope. It doesn't specify whether it retrieves a single issue or multiple issues, and it doesn't distinguish from siblings like 'get_issue' or 'search_issues' which likely have different functionalities.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides no guidance on when to use this tool versus alternatives. With siblings like 'get_issue', 'get_issue_attachments', and 'search_issues', there's no indication of how this tool differs in usage context, prerequisites, or when it should be preferred over other options.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/yuezheng2006/mcp-server-jira'

If you have feedback or need assistance with the MCP directory API, please join our Discord server