add_attachment
Attach files to JIRA issues by providing the issue key, file content in base64 format, and filename. This tool enables users to add documentation, screenshots, or other supporting materials directly to their JIRA tickets.
Instructions
Add a file attachment to a JIRA issue
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| issueKey | Yes | The key of the issue to add attachment to | |
| fileContent | Yes | Base64 encoded content of the file | |
| filename | Yes | Name of the file to be attached |
Implementation Reference
- src/services/jira-api.ts:468-500 (handler)Core handler function that performs the actual file upload to Jira issue via REST API endpoint /attachments.
async addAttachment( issueKey: string, file: Buffer, filename: string ): Promise<{ id: string; filename: string }> { const formData = new FormData(); formData.append("file", new Blob([file]), filename); const headers = new Headers(this.headers); headers.delete("Content-Type"); headers.set("X-Atlassian-Token", "no-check"); const response = await fetch( `${this.baseUrl}/rest/api/3/issue/${issueKey}/attachments`, { method: "POST", headers, body: formData, } ); if (!response.ok) { await this.handleFetchError(response); } const data = await response.json(); const attachment = data[0]; return { id: attachment.id, filename: attachment.filename, }; } - src/index.ts:417-453 (handler)MCP tool dispatch handler: validates input, decodes base64 file content, calls JiraApiService.addAttachment, formats response.
case "add_attachment": { if ( !args.issueKey || typeof args.issueKey !== "string" || !args.fileContent || typeof args.fileContent !== "string" || !args.filename || typeof args.filename !== "string" ) { throw new McpError( ErrorCode.InvalidParams, "issueKey, fileContent, and filename are required", ); } const fileBuffer = Buffer.from(args.fileContent, "base64"); const result = await this.jiraApi.addAttachment( args.issueKey, fileBuffer, args.filename, ); return { content: [ { type: "text", text: JSON.stringify( { message: `File ${args.filename} attached successfully to issue ${args.issueKey}`, attachmentId: result.id, filename: result.filename, }, null, 2, ), }, ], }; } - src/index.ts:223-245 (schema)Input schema definition for the add_attachment tool, provided in listTools response.
{ name: "add_attachment", description: "Add a file attachment to a JIRA issue", inputSchema: { type: "object", properties: { issueKey: { type: "string", description: "The key of the issue to add attachment to", }, fileContent: { type: "string", description: "Base64 encoded content of the file", }, filename: { type: "string", description: "Name of the file to be attached", }, }, required: ["issueKey", "fileContent", "filename"], additionalProperties: false, }, }, - src/index.ts:83-266 (registration)Tool registration in the listTools request handler, including add_attachment in the tools array.
tools: [ { name: "search_issues", description: "Search JIRA issues using JQL", inputSchema: { type: "object", properties: { searchString: { type: "string", description: "JQL search string", }, }, required: ["searchString"], additionalProperties: false, }, }, { name: "get_epic_children", description: "Get all child issues in an epic including their comments", inputSchema: { type: "object", properties: { epicKey: { type: "string", description: "The key of the epic issue", }, }, required: ["epicKey"], additionalProperties: false, }, }, { name: "get_issue", description: "Get detailed information about a specific JIRA issue including comments", inputSchema: { type: "object", properties: { issueId: { type: "string", description: "The ID or key of the JIRA issue", }, }, required: ["issueId"], additionalProperties: false, }, }, { name: "create_issue", description: "Create a new JIRA issue", inputSchema: { type: "object", properties: { projectKey: { type: "string", description: "The project key where the issue will be created", }, issueType: { type: "string", description: 'The type of issue to create (e.g., "Bug", "Story", "Task")', }, summary: { type: "string", description: "The issue summary/title", }, description: { type: "string", description: "The issue description", }, fields: { type: "object", description: "Additional fields to set on the issue", additionalProperties: true, }, }, required: ["projectKey", "issueType", "summary"], additionalProperties: false, }, }, { name: "update_issue", description: "Update an existing JIRA issue", inputSchema: { type: "object", properties: { issueKey: { type: "string", description: "The key of the issue to update", }, fields: { type: "object", description: "Fields to update on the issue", additionalProperties: true, }, }, required: ["issueKey", "fields"], additionalProperties: false, }, }, { name: "get_transitions", description: "Get available status transitions for a JIRA issue", inputSchema: { type: "object", properties: { issueKey: { type: "string", description: "The key of the issue to get transitions for", }, }, required: ["issueKey"], additionalProperties: false, }, }, { name: "transition_issue", description: "Change the status of a JIRA issue by performing a transition", inputSchema: { type: "object", properties: { issueKey: { type: "string", description: "The key of the issue to transition", }, transitionId: { type: "string", description: "The ID of the transition to perform", }, comment: { type: "string", description: "Optional comment to add with the transition", }, }, required: ["issueKey", "transitionId"], additionalProperties: false, }, }, { name: "add_attachment", description: "Add a file attachment to a JIRA issue", inputSchema: { type: "object", properties: { issueKey: { type: "string", description: "The key of the issue to add attachment to", }, fileContent: { type: "string", description: "Base64 encoded content of the file", }, filename: { type: "string", description: "Name of the file to be attached", }, }, required: ["issueKey", "fileContent", "filename"], additionalProperties: false, }, }, { name: "add_comment", description: "Add a comment to a JIRA issue", inputSchema: { type: "object", properties: { issueIdOrKey: { type: "string", description: "The ID or key of the issue to add the comment to", }, body: { type: "string", description: "The content of the comment (plain text)", }, }, required: ["issueIdOrKey", "body"], additionalProperties: false, }, }, ], }));