diff --git a/Dockerfile b/Dockerfile new file mode 100644 index 0000000..469c3af --- /dev/null +++ b/Dockerfile @@ -0,0 +1,22 @@ +# Generated by https://smithery.ai. See: https://smithery.ai/docs/config#dockerfile +FROM node:lts-alpine + +# Create app directory +WORKDIR /mcp-shrimp-task-manager + +# Install app dependencies +COPY package*.json ./ + +# Install dependencies without running lifecycle scripts +RUN npm install --ignore-scripts + +# Bundle app source code +COPY . . + +# Build the TypeScript code +RUN npm run build + +# Expose port if necessary (not required by MCP over stdio) + +# Command to run the MCP server +CMD [ "npm", "run", "start" ] diff --git a/README.md b/README.md index 096264b..8606a10 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,7 @@ # MCP 蝦米任務管理器 +[![smithery badge](https://smithery.ai/badge/@cjo4m06/mcp-shrimp-task-manager)](https://smithery.ai/server/@cjo4m06/mcp-shrimp-task-manager) + > 🚀 基於 Model Context Protocol (MCP) 的智能任務管理系統,為 AI Agent 提供高效的程式開發工作流程框架。 蝦米任務管理器透過結構化的工作流程引導,協助 Agent 系統性規劃程式開發步驟,強化任務記憶管理機制,有效避免冗餘與重複的編程工作。 @@ -35,6 +37,15 @@ ## 🔧 安裝與使用 +### Installing via Smithery + +To install 蝦米任務管理器 for Claude Desktop automatically via [Smithery](https://smithery.ai/server/@cjo4m06/mcp-shrimp-task-manager): + +```bash +npx -y @smithery/cli install @cjo4m06/mcp-shrimp-task-manager --client claude +``` + +### Manual Installation ```bash # 安裝依賴套件 npm install diff --git a/smithery.yaml b/smithery.yaml new file mode 100644 index 0000000..c263d1a --- /dev/null +++ b/smithery.yaml @@ -0,0 +1,24 @@ +# Smithery configuration file: https://smithery.ai/docs/config#smitheryyaml + +startCommand: + type: stdio + configSchema: + # JSON Schema defining the configuration options for the MCP. + type: object + required: + - dataDir + properties: + dataDir: + type: string + description: Absolute path to the data directory for task data storage + description: Configuration for shrimp task manager. dataDir must be an absolute path. + commandFunction: + # A JS function that produces the CLI command based on the given config to start the MCP on stdio. + |- + (config) => ({ + command: 'node', + args: ['/mcp-shrimp-task-manager/dist/index.js'], + env: { DATA_DIR: config.dataDir } + }) + exampleConfig: + dataDir: /var/lib/mcp-shrimp-task-manager/data