From c82f79a529e3fb46b60fabc586f5293e0baddbb8 Mon Sep 17 00:00:00 2001 From: Morax Date: Tue, 29 Jul 2025 13:54:15 +0800 Subject: [PATCH] feat: Update README and package.json for server configuration and repository details --- .npmignore | 61 ++++++++++++++++++++++++++++++++++++++++++++++++++++ LICENSE | 21 ++++++++++++++++++ README.md | 40 ++++++++++++++++++++++++++++++++++ package.json | 15 ++++++++++++- 4 files changed, 136 insertions(+), 1 deletion(-) create mode 100644 .npmignore create mode 100644 LICENSE diff --git a/.npmignore b/.npmignore new file mode 100644 index 0000000..dcd8f03 --- /dev/null +++ b/.npmignore @@ -0,0 +1,61 @@ +# Source files +src/ +*.ts +!*.d.ts + +# Development files +.env +.env.* +*.log +npm-debug.log* +yarn-debug.log* +yarn-error.log* + +# Testing +coverage/ +.nyc_output +*.lcov + +# Build tools +tsconfig.json +jest.config.js +.eslintrc.* +.prettierrc.* + +# Development dependencies +node_modules/ +.npm + +# IDE +.vscode/ +.idea/ +*.swp +*.swo + +# OS +.DS_Store +Thumbs.db + +# Docker +Dockerfile +docker-compose.yml +deploy.sh + +# Git +.git/ +.gitignore + +# Examples and docs (keep README.md) +examples/ +docs/ +*.md +!README.md + +# Test files +test/ +tests/ +__tests__/ +*.test.js +*.test.ts +*.spec.js +*.spec.ts diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..62115d7 --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2024 Morax + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md index 364f1d7..e8f1db8 100644 --- a/README.md +++ b/README.md @@ -382,12 +382,52 @@ Options: - `NODE_ENV` - Environment (development/production) - `PORT` - Server port (default: 3000) +## 📦 Server Config + +For ModelScope MCP deployment and other MCP clients: + +```json +{ + "command": "npx", + "args": ["tarot-mcp-server@latest"], + "env": { + "NODE_ENV": "production" + } +} +``` + +Alternative configurations: + +```json +{ + "command": "npx", + "args": ["tarot-mcp-server@latest", "--transport", "http", "--port", "3000"], + "env": { + "NODE_ENV": "production", + "PORT": "3000" + } +} +``` + ## 🎯 MCP Client Integration ### Cursor IDE Add to your Cursor `mcp.json`: +```json +{ + "mcpServers": { + "tarot": { + "command": "npx", + "args": ["tarot-mcp-server@latest"] + } + } +} +``` + +Or for local development: + ```json { "mcpServers": { diff --git a/package.json b/package.json index 8506d5d..808fa81 100644 --- a/package.json +++ b/package.json @@ -54,5 +54,18 @@ }, "engines": { "node": ">=18.0.0" - } + }, + "files": [ + "dist/**/*", + "README.md", + "LICENSE" + ], + "repository": { + "type": "git", + "url": "https://git.moraxcheng.me/Morax/tarot-mcp.git" + }, + "bugs": { + "url": "https://git.moraxcheng.me/Morax/tarot-mcp/issues" + }, + "homepage": "https://git.moraxcheng.me/Morax/tarot-mcp#readme" }