@jira-deploy/mcp 1.0.0 → 1.0.12

package/.env.example

@@ -11,7 +11,10 @@ JIRA_USER_EMAIL=your-email@company.com
 JIRA_API_TOKEN=your_jira_api_token
 
 # 預設專案 key（可在開單時 override）
-JIRA_PROJECT_KEY=OPS
+JIRA_PROJECT_KEY=PROJ
+
+# Tenant-specific workflow config. Prefer a local JSON file for large configs.
+JIRA_DEPLOY_CONFIG_PATH=
 
 # 輪詢設定
 POLL_INTERVAL_MS=30000
@@ -28,11 +31,10 @@ CONF_TOKEN=your-confluence-token
 # Jabber (XMPP)
 # Prefer storing the password in macOS Keychain and leave JABBER_PASSWORD empty.
 # Set JABBER_PASSWORD only for CI or quick overrides.
-JABBER_SERVER=10.244.192.137
-JABBER_USER=your_jabber_account_number # e.g., BK00619
-JABBER_DOMAIN=linebank.com.tw
+JABBER_SERVER=xmpp.example.internal
+JABBER_USER=your_jabber_user
+JABBER_DOMAIN=example.internal
 JABBER_PASSWORD=
 JABBER_KEYCHAIN_SERVICE=jabber-copilot
-JABBER_KEYCHAIN_ACCOUNT=your_jabber_account_number # e.g., BK00619
+JABBER_KEYCHAIN_ACCOUNT=your_jabber_user
 JABBER_TO=
-JABBER_NOTIFY_SCRIPT=src/scripts/jabber_notify.py

package/README.md

@@ -29,7 +29,7 @@ npm install -g @jira-deploy/mcp
 npx -y @jira-deploy/mcp
 ```
 
-MCP app 維持走 npm / npx 發布與安裝，不提供 binary / Homebrew 安裝。
+MCP app 維持走 npm / npx 發布與安裝，不提供 standalone binary 安裝。
 
 ### 本地開發 / 從 monorepo 啟動
 
@@ -60,7 +60,8 @@ cp .env.example .env
         "BITBUCKET_URL": "https://bitbucket.example.com",
         "BITBUCKET_API_TOKEN": "your_bitbucket_api_token",
         "CONF_BASE_URL": "https://confluence.example.com",
-        "CONF_TOKEN": "your_confluence_token"
+        "CONF_TOKEN": "your_confluence_token",
+        "JIRA_DEPLOY_CONFIG_PATH": "/path/to/jira-deploy-config.json"
       }
     }
   }
@@ -75,12 +76,12 @@ cp .env.example .env
 安裝好並接入 MCP client 後，可以直接在 Chat 裡說：
 
 ```text
-幫我開一張 IBK STG 上版單
-把 CID-1718 切到 Pending Approval
-等 CID-1718 被 approve
-把 CID-1718 切到 Approved
-查 CID-1718 的狀態跟留言
-查 tw-bank-webapp 這個 PR 的 diff
+幫我開一張 APP STG 上版單
+把 PROJ-123 切到 Pending Approval
+等 PROJ-123 被 approve
+把 PROJ-123 切到 Approved
+查 PROJ-123 的狀態跟留言
+查 demo-web 這個 PR 的 diff
 查 Confluence Release Manager 值班表
 ```
 
@@ -132,17 +133,17 @@ Confluence:
 開一張 A平台 STG 上版單，版號 v1.2.3
 
 # 2. 切狀態等待審核
-把 OPS-123 切到 Pending Approval
+把 PROJ-123 切到 Pending Approval
 
 # 3. 等待 Approve（Copilot 會輪詢）
-等 OPS-123 被 approve
+等 PROJ-123 被 approve
 
 # 4. Approve 後切狀態（觸發 Jira Automation → Jenkins）
-把 OPS-123 切到 Approved
+把 PROJ-123 切到 Approved
 
 # 5. 等部署完成後收尾
-在 OPS-123 加留言「STG 部署完成，build: https://jenkins/...」
-把 OPS-123 切到 Done
+在 PROJ-123 加留言「STG 部署完成，build: https://jenkins/...」
+把 PROJ-123 切到 Done
 ```
 
 ## 平台設定
@@ -152,7 +153,7 @@ Confluence:
 ```js
 export const PLATFORMS = {
   'a平台': {
-    projectKey: 'OPS',
+    projectKey: 'PROJ',
     issueType: 'Task',
     components: ['A Platform'],
     labels: ['deploy', 'stg'],

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jira-deploy/mcp",
-  "version": "1.0.0",
+  "version": "1.0.12",
   "description": "MCP Server for Jira deploy ticket workflow",
   "type": "module",
   "main": "./src/index.js",
@@ -13,7 +13,10 @@
     "jira-deploy-mcp": "./src/index.js"
   },
   "files": [
-    "src/**/*.js",
+    "src/env.js",
+    "src/index.js",
+    "src/server.js",
+    "src/utility-tools.js",
     "README.md",
     ".env.example"
   ],
@@ -24,10 +27,11 @@
   "dependencies": {
     "@modelcontextprotocol/sdk": "^1.0.0",
     "dotenv": "^16.3.0",
-    "@jira-deploy/core": "1.0.0"
+    "@jira-deploy/core": "1.0.12"
   },
   "scripts": {
     "start": "node src/index.js",
-    "dev": "node --watch src/index.js"
+    "dev": "node --watch src/index.js",
+    "test": "node --test src/*.test.js"
   }
 }

package/src/env.js

@@ -0,0 +1,11 @@
+import {config} from 'dotenv';
+
+export function loadMcpEnv({
+  packageEnvPath,
+  configImpl = config,
+} = {}) {
+  configImpl();
+  if (packageEnvPath) {
+    configImpl({path: packageEnvPath});
+  }
+}

package/src/index.js

@@ -1,51 +1,15 @@
 #!/usr/bin/env node
-import {config} from 'dotenv';
 import {fileURLToPath} from 'url';
 import {dirname, join} from 'path';
-import {Server} from '@modelcontextprotocol/sdk/server/index.js';
-import {StdioServerTransport} from '@modelcontextprotocol/sdk/server/stdio.js';
-import {
-  CallToolRequestSchema,
-  ListToolsRequestSchema,
-} from '@modelcontextprotocol/sdk/types.js';
-import {JiraClient, Notifier, getToolDefinitions, executeTool} from '@jira-deploy/core';
-import {getUtilityToolDefinitions, executeUtilityTool} from './utility-tools.js';
+import {loadMcpEnv} from './env.js';
 
 const __dirname = dirname(fileURLToPath(import.meta.url));
-config({path: join(__dirname, '..', '.env')});
+loadMcpEnv({packageEnvPath: join(__dirname, '..', '.env')});
 
-const jira = new JiraClient();
-const notifier = new Notifier(jira);
-
-const server = new Server(
-  {name: '@jira-deploy/mcp', version: '1.0.0'},
-  {capabilities: {tools: {}}}
-);
-
-server.setRequestHandler(ListToolsRequestSchema, async () => ({
-  tools: [...getToolDefinitions(), ...getUtilityToolDefinitions()],
-}));
-
-server.setRequestHandler(CallToolRequestSchema, async (request) => {
-  const {name, arguments: args} = request.params;
-
-  try {
-    const utilityResult = await executeUtilityTool(name, args ?? {});
-    if (utilityResult) return utilityResult;
-    return await executeTool(name, args ?? {}, {jira, notifier});
-  } catch (err) {
-    return {
-      content: [
-        {
-          type: 'text',
-          text: JSON.stringify({error: err.message}),
-        },
-      ],
-      isError: true,
-    };
-  }
-});
+const {StdioServerTransport} = await import('@modelcontextprotocol/sdk/server/stdio.js');
+const {createMcpServer} = await import('./server.js');
 
+const server = createMcpServer();
 const transport = new StdioServerTransport();
 await server.connect(transport);
 console.error('[@jira-deploy/mcp] MCP Server ready');

package/src/server.js

@@ -0,0 +1,64 @@
+import {Server} from '@modelcontextprotocol/sdk/server/index.js';
+import {
+  CallToolRequestSchema,
+  ListToolsRequestSchema,
+} from '@modelcontextprotocol/sdk/types.js';
+import {JiraClient, Notifier, getToolDefinitions, executeTool} from '@jira-deploy/core';
+import {getUtilityToolDefinitions, executeUtilityTool} from './utility-tools.js';
+
+const NON_JIRA_CORE_TOOL_NAMES = new Set([
+  'get_release_manager',
+  'send_jabber_message',
+]);
+
+export function createJiraDeps() {
+  const jira = new JiraClient();
+  return {jira, notifier: new Notifier(jira)};
+}
+
+export async function listTools() {
+  return {
+    tools: [...getToolDefinitions(), ...getUtilityToolDefinitions()],
+  };
+}
+
+export async function callTool(
+  request,
+  {
+    createDeps = createJiraDeps,
+    executeToolImpl = executeTool,
+    executeUtilityToolImpl = executeUtilityTool,
+  } = {},
+) {
+  const {name, arguments: args} = request.params;
+
+  try {
+    const utilityResult = await executeUtilityToolImpl(name, args ?? {});
+    if (utilityResult) return utilityResult;
+
+    const deps = NON_JIRA_CORE_TOOL_NAMES.has(name) ? {} : createDeps();
+    return await executeToolImpl(name, args ?? {}, deps);
+  } catch (err) {
+    return {
+      content: [
+        {
+          type: 'text',
+          text: JSON.stringify({error: err.message}),
+        },
+      ],
+      isError: true,
+    };
+  }
+}
+
+export function createMcpServer(options = {}) {
+  const server = new Server(
+    {name: '@jira-deploy/mcp', version: '1.0.3'},
+    {capabilities: {tools: {}}},
+  );
+
+  server.setRequestHandler(ListToolsRequestSchema, async () => listTools());
+  server.setRequestHandler(CallToolRequestSchema, async (request) => callTool(request, options));
+
+  return server;
+}

package/src/utility-tools.js

@@ -143,19 +143,29 @@ function stripHtml(html) {
     .trim();
 }
 
+function readOnlyTool(tool) {
+  return {
+    ...tool,
+    annotations: {
+      ...tool.annotations,
+      readOnlyHint: true,
+    },
+  };
+}
+
 export function getUtilityToolDefinitions() {
   return [
-    {
+    readOnlyTool({
       name: 'jira_get_issue',
       description:
         'Get a Jira issue by key. Returns summary, status, type, priority, assignee, description, comments, linked issues, and attachments.',
       inputSchema: {
         type: 'object',
         required: ['issueKey'],
-        properties: {issueKey: {type: 'string', description: 'Jira issue key, e.g. LBPRJ-10949'}},
+        properties: {issueKey: {type: 'string', description: 'Jira issue key, e.g. PROJ-123'}},
       },
-    },
-    {
+    }),
+    readOnlyTool({
       name: 'jira_search_issues',
       description: 'Search Jira issues using JQL. Returns key, summary, status, type, priority, and assignee.',
       inputSchema: {
@@ -166,8 +176,8 @@ export function getUtilityToolDefinitions() {
           maxResults: {type: 'number', default: 20, description: 'Max results to return'},
         },
       },
-    },
-    {
+    }),
+    readOnlyTool({
       name: 'bitbucket_list_prs',
       description: 'List pull requests for a Bitbucket repository.',
       inputSchema: {
@@ -180,8 +190,8 @@ export function getUtilityToolDefinitions() {
           limit: {type: 'number', default: 25},
         },
       },
-    },
-    {
+    }),
+    readOnlyTool({
       name: 'bitbucket_get_pr',
       description: 'Get Bitbucket pull request details and recent activity.',
       inputSchema: {
@@ -193,8 +203,8 @@ export function getUtilityToolDefinitions() {
           prId: {type: 'number'},
         },
       },
-    },
-    {
+    }),
+    readOnlyTool({
       name: 'bitbucket_get_pr_changes',
       description: 'Get the list of changed files in a Bitbucket pull request.',
       inputSchema: {
@@ -206,8 +216,8 @@ export function getUtilityToolDefinitions() {
           prId: {type: 'number'},
         },
       },
-    },
-    {
+    }),
+    readOnlyTool({
       name: 'bitbucket_get_pr_diff',
       description: 'Get Bitbucket pull request diff content for code review.',
       inputSchema: {
@@ -226,8 +236,8 @@ export function getUtilityToolDefinitions() {
           },
         },
       },
-    },
-    {
+    }),
+    readOnlyTool({
       name: 'bitbucket_get_pr_comments',
       description: 'Get all comments on a Bitbucket pull request, including inline anchors.',
       inputSchema: {
@@ -239,7 +249,7 @@ export function getUtilityToolDefinitions() {
           prId: {type: 'number'},
         },
       },
-    },
+    }),
     {
       name: 'bitbucket_add_pr_comment',
       description: 'Add a general comment to a Bitbucket pull request.',
@@ -273,7 +283,7 @@ export function getUtilityToolDefinitions() {
         },
       },
     },
-    {
+    readOnlyTool({
       name: 'bitbucket_get_file',
       description: 'Get raw file content from a Bitbucket repository.',
       inputSchema: {
@@ -286,8 +296,8 @@ export function getUtilityToolDefinitions() {
           branch: {type: 'string', default: 'master'},
         },
       },
-    },
-    {
+    }),
+    readOnlyTool({
       name: 'confluence_search',
       description: 'Search Confluence pages using CQL.',
       inputSchema: {
@@ -298,8 +308,8 @@ export function getUtilityToolDefinitions() {
           limit: {type: 'number', default: 10},
         },
       },
-    },
-    {
+    }),
+    readOnlyTool({
       name: 'confluence_get_page',
       description: 'Get full readable content of a Confluence page by ID.',
       inputSchema: {
@@ -307,8 +317,8 @@ export function getUtilityToolDefinitions() {
         required: ['pageId'],
         properties: {pageId: {type: 'string'}},
       },
-    },
-    {
+    }),
+    readOnlyTool({
       name: 'confluence_get_children',
       description: 'Get child pages of a Confluence page.',
       inputSchema: {
@@ -316,8 +326,8 @@ export function getUtilityToolDefinitions() {
         required: ['pageId'],
         properties: {pageId: {type: 'string'}, limit: {type: 'number', default: 25}},
       },
-    },
-    {
+    }),
+    readOnlyTool({
       name: 'confluence_list_spaces',
       description: 'List available Confluence spaces.',
       inputSchema: {
@@ -325,8 +335,8 @@ export function getUtilityToolDefinitions() {
         required: [],
         properties: {limit: {type: 'number', default: 20}},
       },
-    },
-    {
+    }),
+    readOnlyTool({
       name: 'confluence_get_page_storage',
       description: 'Get raw Confluence storage-format HTML for a page.',
       inputSchema: {
@@ -334,7 +344,7 @@ export function getUtilityToolDefinitions() {
         required: ['pageId'],
         properties: {pageId: {type: 'string'}},
       },
-    },
+    }),
     {
       name: 'confluence_create_page',
       description: 'Create a new Confluence page under a parent page. Body must be storage-format HTML.',
@@ -363,7 +373,7 @@ export function getUtilityToolDefinitions() {
         },
       },
     },
-    {
+    readOnlyTool({
       name: 'confluence_list_versions',
       description: 'List historical versions of a Confluence page.',
       inputSchema: {
@@ -375,8 +385,8 @@ export function getUtilityToolDefinitions() {
           start: {type: 'number', default: 0},
         },
       },
-    },
-    {
+    }),
+    readOnlyTool({
       name: 'confluence_get_page_version',
       description: 'Get readable body and metadata of a historical Confluence page version.',
       inputSchema: {
@@ -384,8 +394,8 @@ export function getUtilityToolDefinitions() {
         required: ['pageId', 'version'],
         properties: {pageId: {type: 'string'}, version: {type: 'number'}},
       },
-    },
-    {
+    }),
+    readOnlyTool({
       name: 'confluence_get_calendar_events',
       description:
         'Query Confluence Team Calendar events. Useful for finding Release Manager / Sign off staff.',
@@ -397,7 +407,7 @@ export function getUtilityToolDefinitions() {
           date: {type: 'string', description: 'YYYY-MM-DD'},
         },
       },
-    },
+    }),
   ];
 }
 
@@ -875,8 +885,8 @@ async function confluenceGetCalendarEvents({subCalendarId, date}) {
     return ok({
       date,
       total: 1,
-      events: [{what: 'Sign off staff', who: 'Alvin Wang (BK00236)'}],
-      signOffStaff: {name: 'Alvin Wang (BK00236)'},
+      events: [{what: 'Sign off staff', who: 'Demo User (demo-user)'}],
+      signOffStaff: {name: 'Demo User (demo-user)'},
       dryRun: true,
     });
   }