@jira-deploy/mcp 1.0.16 → 1.0.17

package/README.md

@@ -29,6 +29,12 @@ npm install -g @jira-deploy/mcp
 npx -y @jira-deploy/mcp
 ```
 
+如果要使用 JSON config，可透過 `--config` 明確傳入：
+
+```bash
+npx -y @jira-deploy/mcp --config ~/.ares/config.json
+```
+
 MCP app 維持走 npm / npx 發布與安裝，不提供 standalone binary 安裝。
 
 ### 本地開發 / 從 monorepo 啟動
@@ -53,23 +59,17 @@ cp .env.example .env
   "servers": {
     "jira-deploy": {
       "command": "npx",
-      "args": ["-y", "@jira-deploy/mcp"],
+      "args": ["-y", "@jira-deploy/mcp", "--config", "/path/to/config.json"],
       "env": {
         "JIRA_BASE_URL": "https://your-org.atlassian.net",
-        "JIRA_API_TOKEN": "your_jira_api_token",
-        "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",
-        "JIRA_DEPLOY_CONFIG_PATH": "/path/to/jira-deploy-config.json"
+        "JIRA_API_TOKEN": "your_jira_api_token"
       }
     }
   }
 }
 ```
 
-建議把 Jira 的機密設定放在系統環境變數或 `.env` 檔，
-不要 commit 到 git（`.env` 已在 .gitignore）。
+建議把 Jira、Bitbucket、Confluence、Jabber 的機密設定放在 JSON config、系統環境變數或 `.env` 檔，不要 commit 到 git（`.env` 已在 .gitignore）。`--config` 的值會優先於 shell env；未使用 `--config` 時，MCP 仍可讀取既有 env。
 
 ## 使用者端使用方式
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jira-deploy/mcp",
-  "version": "1.0.16",
+  "version": "1.0.17",
   "description": "MCP Server for Jira deploy ticket workflow",
   "type": "module",
   "main": "./src/index.js",
@@ -27,7 +27,7 @@
   "dependencies": {
     "@modelcontextprotocol/sdk": "^1.0.0",
     "dotenv": "^16.3.0",
-    "@jira-deploy/core": "1.0.16"
+    "@jira-deploy/core": "1.0.17"
   },
   "scripts": {
     "start": "node src/index.js",

package/src/env.js

@@ -1,4 +1,5 @@
 import {config} from 'dotenv';
+import {readFileSync} from 'node:fs';
 
 export function loadMcpEnv({
   packageEnvPath,
@@ -9,3 +10,105 @@ export function loadMcpEnv({
     configImpl({path: packageEnvPath});
   }
 }
+
+const CONFIG_ENV_MAP = [
+  ['jira.baseUrl', 'JIRA_BASE_URL'],
+  ['jira.apiToken', 'JIRA_API_TOKEN'],
+  ['jira.deployConfigPath', 'JIRA_DEPLOY_CONFIG_PATH'],
+  ['jira.projectKey', 'JIRA_PROJECT_KEY'],
+  ['jira.releaseProjectKey', 'JIRA_RELEASE_PROJECT_KEY'],
+  ['bitbucket.url', 'BITBUCKET_URL'],
+  ['bitbucket.baseUrl', 'BITBUCKET_BASE_URL'],
+  ['bitbucket.apiToken', 'BITBUCKET_API_TOKEN'],
+  ['confluence.baseUrl', 'CONF_BASE_URL'],
+  ['confluence.token', 'CONF_TOKEN'],
+  ['poll.intervalMs', 'POLL_INTERVAL_MS'],
+  ['poll.timeoutMs', 'POLL_TIMEOUT_MS'],
+  ['jabber.notifyScript', 'JABBER_NOTIFY_SCRIPT'],
+  ['jabber.server', 'JABBER_SERVER'],
+  ['jabber.user', 'JABBER_USER'],
+  ['jabber.domain', 'JABBER_DOMAIN'],
+  ['jabber.keychainService', 'JABBER_KEYCHAIN_SERVICE'],
+  ['jabber.keychainAccount', 'JABBER_KEYCHAIN_ACCOUNT'],
+  ['jabber.to', 'JABBER_TO'],
+  ['jabber.room', 'JABBER_ROOM'],
+  ['jabber.port', 'JABBER_PORT'],
+  ['jabber.resource', 'JABBER_RESOURCE'],
+  ['jabber.nick', 'JABBER_NICK'],
+];
+
+function isPlainObject(value) {
+  return Boolean(value) && typeof value === 'object' && !Array.isArray(value);
+}
+
+function getPathValue(object, path) {
+  return path.split('.').reduce((current, segment) => (
+    isPlainObject(current) && Object.hasOwn(current, segment) ? current[segment] : undefined
+  ), object);
+}
+
+function hasConfigValue(value) {
+  return value !== undefined && value !== null && value !== '';
+}
+
+function stringifyConfigValue(value) {
+  if (typeof value === 'boolean') {
+    return value ? 'true' : 'false';
+  }
+  return String(value);
+}
+
+export function parseMcpArgs(args = process.argv.slice(2)) {
+  const remainingArgs = [];
+  let configPath = null;
+  for (let index = 0; index < args.length; index += 1) {
+    const arg = args[index];
+    if (arg === '--config') {
+      configPath = args[index + 1] ?? null;
+      index += 1;
+      continue;
+    }
+    remainingArgs.push(arg);
+  }
+  return {configPath, remainingArgs};
+}
+
+export function mcpJsonConfigToCoreEnv(configValue) {
+  const nextEnv = {};
+  if (!isPlainObject(configValue)) {
+    return nextEnv;
+  }
+
+  for (const [configPath, envKey] of CONFIG_ENV_MAP) {
+    const value = getPathValue(configValue, configPath);
+    if (hasConfigValue(value)) {
+      nextEnv[envKey] = stringifyConfigValue(value);
+    }
+  }
+
+  if (typeof configValue.dryRun === 'boolean') {
+    nextEnv.DRY_RUN = stringifyConfigValue(configValue.dryRun);
+  }
+
+  if (isPlainObject(configValue.env)) {
+    for (const [key, value] of Object.entries(configValue.env)) {
+      if (hasConfigValue(value)) {
+        nextEnv[key] = stringifyConfigValue(value);
+      }
+    }
+  }
+
+  return nextEnv;
+}
+
+export function loadMcpRuntimeConfig({
+  configPath,
+  readConfig = (path) => JSON.parse(readFileSync(path, 'utf8')),
+} = {}) {
+  if (!configPath) {
+    return {};
+  }
+  return {
+    env: mcpJsonConfigToCoreEnv(readConfig(configPath)),
+  };
+}

package/src/index.js

@@ -1,10 +1,13 @@
 #!/usr/bin/env node
 import {fileURLToPath} from 'url';
 import {dirname, join} from 'path';
-import {loadMcpEnv} from './env.js';
+import {loadMcpEnv, loadMcpRuntimeConfig, parseMcpArgs} from './env.js';
 
 const __dirname = dirname(fileURLToPath(import.meta.url));
 loadMcpEnv({packageEnvPath: join(__dirname, '..', '.env')});
+const {configPath} = parseMcpArgs();
+const {configureRuntimeConfig} = await import('@jira-deploy/core/runtime-config');
+configureRuntimeConfig(loadMcpRuntimeConfig({configPath}));
 
 const {StdioServerTransport} = await import('@modelcontextprotocol/sdk/server/stdio.js');
 const {createMcpServer} = await import('./server.js');

package/src/utility-tools.js

@@ -1,7 +1,10 @@
 import http from 'http';
 import https from 'https';
+import {getRuntimeConfigValue} from '@jira-deploy/core/runtime-config';
 
-const DRY_RUN = process.env.DRY_RUN === 'true';
+function isDryRun() {
+  return getRuntimeConfigValue('DRY_RUN') === 'true';
+}
 
 function ok(data) {
   return {content: [{type: 'text', text: JSON.stringify(data, null, 2)}]};
@@ -12,9 +15,9 @@ function text(data) {
 }
 
 function requiredEnv(names, label) {
-  const values = Object.fromEntries(names.map((name) => [name, process.env[name]]));
+  const values = Object.fromEntries(names.map((name) => [name, getRuntimeConfigValue(name)]));
   const missing = names.filter((name) => !values[name]);
-  if (missing.length > 0 && !DRY_RUN) {
+  if (missing.length > 0 && !isDryRun()) {
     throw new Error(`${label} requires env vars: ${missing.join(', ')}`);
   }
   return values;
@@ -109,18 +112,18 @@ function requestText(baseUrl, path, {token, timeoutMs = 15000} = {}) {
 }
 
 function jiraConfig() {
-  const baseUrl = process.env.JIRA_BASE_URL;
-  const token = process.env.JIRA_API_TOKEN ?? process.env.JIRA_TOKEN;
-  if (!DRY_RUN && (!baseUrl || !token)) {
+  const baseUrl = getRuntimeConfigValue('JIRA_BASE_URL');
+  const token = getRuntimeConfigValue('JIRA_API_TOKEN') ?? getRuntimeConfigValue('JIRA_TOKEN');
+  if (!isDryRun() && (!baseUrl || !token)) {
     throw new Error('Jira utility tools require JIRA_BASE_URL and JIRA_API_TOKEN');
   }
   return {baseUrl, token};
 }
 
 function bitbucketConfig() {
-  const baseUrl = process.env.BITBUCKET_URL ?? process.env.BITBUCKET_BASE_URL;
-  const token = process.env.BITBUCKET_API_TOKEN ?? process.env.BITBUCKET_TOKEN;
-  if (!DRY_RUN && (!baseUrl || !token)) {
+  const baseUrl = getRuntimeConfigValue('BITBUCKET_URL') ?? getRuntimeConfigValue('BITBUCKET_BASE_URL');
+  const token = getRuntimeConfigValue('BITBUCKET_API_TOKEN') ?? getRuntimeConfigValue('BITBUCKET_TOKEN');
+  if (!isDryRun() && (!baseUrl || !token)) {
     throw new Error('Bitbucket utility tools require BITBUCKET_URL and BITBUCKET_API_TOKEN');
   }
   return {baseUrl, token};
@@ -128,7 +131,7 @@ function bitbucketConfig() {
 
 function confluenceConfig() {
   requiredEnv(['CONF_BASE_URL', 'CONF_TOKEN'], 'Confluence utility tools');
-  return {baseUrl: process.env.CONF_BASE_URL, token: process.env.CONF_TOKEN};
+  return {baseUrl: getRuntimeConfigValue('CONF_BASE_URL'), token: getRuntimeConfigValue('CONF_TOKEN')};
 }
 
 function stripHtml(html) {
@@ -459,7 +462,7 @@ export async function executeUtilityTool(name, args = {}) {
 }
 
 async function jiraGetIssue({issueKey}) {
-  if (DRY_RUN) {
+  if (isDryRun()) {
     return ok({key: issueKey, fields: {summary: '[DRY] Mock issue', status: {name: 'To Do'}}});
   }
   const {baseUrl, token} = jiraConfig();
@@ -496,7 +499,7 @@ async function jiraGetIssue({issueKey}) {
 }
 
 async function jiraSearchIssues({jql, maxResults = 20}) {
-  if (DRY_RUN) return ok({total: 0, issues: []});
+  if (isDryRun()) return ok({total: 0, issues: []});
   const {baseUrl, token} = jiraConfig();
   const data = await requestJson(
     baseUrl,
@@ -515,7 +518,7 @@ async function jiraSearchIssues({jql, maxResults = 20}) {
 }
 
 async function bitbucketListPrs({projectKey, repoSlug, state = 'OPEN', limit = 25}) {
-  if (DRY_RUN) return ok({total: 0, prs: []});
+  if (isDryRun()) return ok({total: 0, prs: []});
   const {baseUrl, token} = bitbucketConfig();
   const data = await requestJson(
     baseUrl,
@@ -535,7 +538,7 @@ async function bitbucketListPrs({projectKey, repoSlug, state = 'OPEN', limit = 2
 }
 
 async function bitbucketGetPr({projectKey, repoSlug, prId}) {
-  if (DRY_RUN) return ok({id: prId, title: '[DRY] Mock PR', state: 'OPEN'});
+  if (isDryRun()) return ok({id: prId, title: '[DRY] Mock PR', state: 'OPEN'});
   const {baseUrl, token} = bitbucketConfig();
   const [pr, activities] = await Promise.all([
     requestJson(baseUrl, `/rest/api/1.0/projects/${projectKey}/repos/${repoSlug}/pull-requests/${prId}`, {token}),
@@ -568,7 +571,7 @@ async function bitbucketGetPr({projectKey, repoSlug, prId}) {
 }
 
 async function bitbucketGetPrChanges({projectKey, repoSlug, prId}) {
-  if (DRY_RUN) return ok({total: 0, files: []});
+  if (isDryRun()) return ok({total: 0, files: []});
   const {baseUrl, token} = bitbucketConfig();
   const data = await requestJson(
     baseUrl,
@@ -591,7 +594,7 @@ async function bitbucketGetPrDiff({
   contextLines = 3,
   excludePatterns = ['__snapshots__', 'messages_en.json', 'messages_ko.json'],
 }) {
-  if (DRY_RUN) return ok({diffs: []});
+  if (isDryRun()) return ok({diffs: []});
   const {baseUrl, token} = bitbucketConfig();
   const pathParam = path ? `&path=${encodeURIComponent(path)}` : '';
   const data = await requestJson(
@@ -634,7 +637,7 @@ async function bitbucketGetPrDiff({
 }
 
 async function bitbucketGetPrComments({projectKey, repoSlug, prId}) {
-  if (DRY_RUN) return ok({total: 0, comments: []});
+  if (isDryRun()) return ok({total: 0, comments: []});
   const {baseUrl, token} = bitbucketConfig();
   const data = await requestJson(
     baseUrl,
@@ -662,7 +665,7 @@ async function bitbucketGetPrComments({projectKey, repoSlug, prId}) {
 
 async function bitbucketAddPrComment({projectKey, repoSlug, prId, text: commentText, parentId}) {
   const {baseUrl, token} = bitbucketConfig();
-  if (DRY_RUN) return ok({success: true, dryRun: true, text: commentText});
+  if (isDryRun()) return ok({success: true, dryRun: true, text: commentText});
   const result = await requestJson(
     baseUrl,
     `/rest/api/1.0/projects/${projectKey}/repos/${repoSlug}/pull-requests/${prId}/comments`,
@@ -682,7 +685,7 @@ async function bitbucketAddPrInlineComment({
   fileType = 'TO',
 }) {
   const {baseUrl, token} = bitbucketConfig();
-  if (DRY_RUN) return ok({success: true, dryRun: true, text: commentText, filePath, line});
+  if (isDryRun()) return ok({success: true, dryRun: true, text: commentText, filePath, line});
   const result = await requestJson(
     baseUrl,
     `/rest/api/1.0/projects/${projectKey}/repos/${repoSlug}/pull-requests/${prId}/comments`,
@@ -699,7 +702,7 @@ async function bitbucketAddPrInlineComment({
 }
 
 async function bitbucketGetFile({projectKey, repoSlug, filePath, branch = 'master'}) {
-  if (DRY_RUN) return text('[DRY] Mock file content');
+  if (isDryRun()) return text('[DRY] Mock file content');
   const {baseUrl, token} = bitbucketConfig();
   const encodedPath = filePath.split('/').map(encodeURIComponent).join('/');
   const content = await requestText(
@@ -711,7 +714,7 @@ async function bitbucketGetFile({projectKey, repoSlug, filePath, branch = 'maste
 }
 
 async function confluenceSearch({query, limit = 10}) {
-  if (DRY_RUN) return ok({total: 0, results: []});
+  if (isDryRun()) return ok({total: 0, results: []});
   const {baseUrl, token} = confluenceConfig();
   const data = await requestJson(
     baseUrl,
@@ -732,7 +735,7 @@ async function confluenceSearch({query, limit = 10}) {
 }
 
 async function confluenceGetPage({pageId}) {
-  if (DRY_RUN) return ok({id: pageId, title: '[DRY] Mock page', body: 'dry'});
+  if (isDryRun()) return ok({id: pageId, title: '[DRY] Mock page', body: 'dry'});
   const {baseUrl, token} = confluenceConfig();
   const data = await requestJson(
     baseUrl,
@@ -755,7 +758,7 @@ async function confluenceGetPage({pageId}) {
 }
 
 async function confluenceGetChildren({pageId, limit = 25}) {
-  if (DRY_RUN) return ok({total: 0, children: []});
+  if (isDryRun()) return ok({total: 0, children: []});
   const {baseUrl, token} = confluenceConfig();
   const data = await requestJson(
     baseUrl,
@@ -772,7 +775,7 @@ async function confluenceGetChildren({pageId, limit = 25}) {
 }
 
 async function confluenceListSpaces({limit = 20}) {
-  if (DRY_RUN) return ok({total: 0, spaces: []});
+  if (isDryRun()) return ok({total: 0, spaces: []});
   const {baseUrl, token} = confluenceConfig();
   const data = await requestJson(baseUrl, `/rest/api/space?limit=${limit}&expand=description.plain`, {
     token,
@@ -787,7 +790,7 @@ async function confluenceListSpaces({limit = 20}) {
 }
 
 async function confluenceGetPageStorage({pageId}) {
-  if (DRY_RUN) return ok({id: pageId, title: '[DRY] Mock page', version: 1, body: '<p>dry</p>'});
+  if (isDryRun()) return ok({id: pageId, title: '[DRY] Mock page', version: 1, body: '<p>dry</p>'});
   const {baseUrl, token} = confluenceConfig();
   const data = await requestJson(baseUrl, `/rest/api/content/${pageId}?expand=body.storage,version,title`, {
     token,
@@ -802,7 +805,7 @@ async function confluenceGetPageStorage({pageId}) {
 
 async function confluenceCreatePage({spaceKey, parentId, title, body}) {
   const {baseUrl, token} = confluenceConfig();
-  if (DRY_RUN) return ok({id: 'DRY', title, url: `${baseUrl}/pages/viewpage.action?pageId=DRY`});
+  if (isDryRun()) return ok({id: 'DRY', title, url: `${baseUrl}/pages/viewpage.action?pageId=DRY`});
   const data = await requestJson(baseUrl, '/rest/api/content', {
     method: 'POST',
     token,
@@ -820,7 +823,7 @@ async function confluenceCreatePage({spaceKey, parentId, title, body}) {
 
 async function confluenceUpdatePage({pageId, title, body, minorEdit = false}) {
   const {baseUrl, token} = confluenceConfig();
-  if (DRY_RUN) return ok({id: pageId, title: title || '[DRY] Mock page', version: 2, dryRun: true});
+  if (isDryRun()) return ok({id: pageId, title: title || '[DRY] Mock page', version: 2, dryRun: true});
   const current = await requestJson(baseUrl, `/rest/api/content/${pageId}?expand=version,title`, {token});
   const nextVersion = (current.version?.number || 0) + 1;
   const resolvedTitle = title || current.title;
@@ -844,7 +847,7 @@ async function confluenceUpdatePage({pageId, title, body, minorEdit = false}) {
 }
 
 async function confluenceListVersions({pageId, limit = 25, start = 0}) {
-  if (DRY_RUN) return ok({total: 0, start, limit, versions: []});
+  if (isDryRun()) return ok({total: 0, start, limit, versions: []});
   const {baseUrl, token} = confluenceConfig();
   const data = await requestJson(
     baseUrl,
@@ -862,7 +865,7 @@ async function confluenceListVersions({pageId, limit = 25, start = 0}) {
 }
 
 async function confluenceGetPageVersion({pageId, version}) {
-  if (DRY_RUN) return ok({id: pageId, title: '[DRY] Mock page', version, body: 'dry'});
+  if (isDryRun()) return ok({id: pageId, title: '[DRY] Mock page', version, body: 'dry'});
   const {baseUrl, token} = confluenceConfig();
   const data = await requestJson(
     baseUrl,
@@ -881,7 +884,7 @@ async function confluenceGetPageVersion({pageId, version}) {
 }
 
 async function confluenceGetCalendarEvents({subCalendarId, date}) {
-  if (DRY_RUN) {
+  if (isDryRun()) {
     return ok({
       date,
       total: 1,