diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml new file mode 100644 index 0000000..151961d --- /dev/null +++ b/.github/workflows/publish.yml @@ -0,0 +1,31 @@ +name: Publish to npm + +on: + push: + tags: + - "v*" # 只有 push tag 才會觸發 + +jobs: + release: + runs-on: ubuntu-latest + environment: NPM + steps: + - name: Checkout code + uses: actions/checkout@v4 + + - name: Use Node.js + uses: actions/setup-node@v4 + with: + node-version: "20" + registry-url: "https://registry.npmjs.org/" + + - name: Install dependencies + run: npm ci + + - name: Build project + run: npm run build + + - name: Publish to npm + run: npm publish --access public + env: + NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }} diff --git a/README.md b/README.md index ca10b5a..f21a3ba 100644 --- a/README.md +++ b/README.md @@ -98,6 +98,21 @@ Shrimp Task Manager offers two configuration methods: global configuration and p "shrimp-task-manager": { "command": "node", "args": ["/mcp-shrimp-task-manager/dist/index.js"], + "env": { + "DATA_DIR": "/path/to/project/data" // 必須使用絕對路徑 + } + } + } +} + + +or + +{ + "mcpServers": { + "shrimp-task-manager": { + "command": "npx", + "args": ["@siage/shrimp-task-manager"], "env": { "DATA_DIR": "/mcp-shrimp-task-manager/data" } @@ -127,6 +142,21 @@ You can also set up dedicated configurations for each project to use independent } } } + + +or + +{ + "mcpServers": { + "shrimp-task-manager": { + "command": "npx", + "args": ["@siage/shrimp-task-manager"], + "env": { + "DATA_DIR": "/path/to/project/data" // 必須使用絕對路徑 + } + } + } +} ``` ### ⚠️ Important Configuration Notes diff --git a/docs/zh/README.md b/docs/zh/README.md index 4bc709b..3b3d3e1 100644 --- a/docs/zh/README.md +++ b/docs/zh/README.md @@ -104,6 +104,20 @@ npm run build } } } + +or + +{ + "mcpServers": { + "shrimp-task-manager": { + "command": "npx", + "args": ["@siage/shrimp-task-manager"], + "env": { + "DATA_DIR": "/mcp-shrimp-task-manager/data" + } + } + } +} ``` > ⚠️ 請將 `/mcp-shrimp-task-manager` 替換為您的實際路徑。 @@ -127,6 +141,20 @@ npm run build } } } + +or + +{ + "mcpServers": { + "shrimp-task-manager": { + "command": "npx", + "args": ["@siage/shrimp-task-manager"], + "env": { + "DATA_DIR": "/path/to/project/data" // 必須使用絕對路徑 + } + } + } +} ``` ### ⚠️ 重要配置說明 diff --git a/package.json b/package.json index 9b2e3b2..7a0215c 100644 --- a/package.json +++ b/package.json @@ -1,9 +1,20 @@ { "name": "mcp-shrimp-task-manager", - "version": "1.0.3", - "description": "基於MCP的任務管理系統,提供任務規劃、拆分和管理功能", + "version": "1.0.5", + "description": "Shrimp Task Manager is a task tool built for AI Agents, emphasizing chain-of-thought, reflection, and style consistency. It converts natural language into structured dev tasks with dependency tracking and iterative refinement, enabling agent-like developer behavior in reasoning AI systems", "main": "dist/index.js", "type": "module", + "repository": { + "type": "git", + "url": "https://github.com/cjo4m06/mcp-shrimp-task-manager" + }, + "bugs": { + "url": "https://github.com/cjo4m06/mcp-shrimp-task-manager/issues" + }, + "homepage": "https://cjo4m06.github.io/mcp-shrimp-task-manager", + "bin": { + "shrimp-task-manager": "./dist/index.js" + }, "scripts": { "build": "tsc", "dev": "ts-node src/index.ts",