feat: Update README and package.json for server configuration and repository details

This commit is contained in:
Morax
2025-07-29 13:54:15 +08:00
parent bad857eeab
commit c82f79a529
4 changed files with 136 additions and 1 deletions

61
.npmignore Normal file
View File

@@ -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

21
LICENSE Normal file
View File

@@ -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.

View File

@@ -382,12 +382,52 @@ Options:
- `NODE_ENV` - Environment (development/production) - `NODE_ENV` - Environment (development/production)
- `PORT` - Server port (default: 3000) - `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 ## 🎯 MCP Client Integration
### Cursor IDE ### Cursor IDE
Add to your Cursor `mcp.json`: Add to your Cursor `mcp.json`:
```json
{
"mcpServers": {
"tarot": {
"command": "npx",
"args": ["tarot-mcp-server@latest"]
}
}
}
```
Or for local development:
```json ```json
{ {
"mcpServers": { "mcpServers": {

View File

@@ -54,5 +54,18 @@
}, },
"engines": { "engines": {
"node": ">=18.0.0" "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"
} }