Merge pull request #23 from modelcontextprotocol/justin/remove-top-package

Don't publish umbrella package anymore
This commit is contained in:
Justin Spahr-Summers 2024-11-21 19:43:32 +00:00 • committed by GitHub
commit 9b1571cf2f
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
10 changed files with 104 additions and 66 deletions

View file

@ -18,31 +18,52 @@ A collection of reference implementations and community-contributed servers for
## 🚀 Getting Started ## 🚀 Getting Started
### Installation The servers in this repository can be used directly with `npx`. For example:
```bash ```sh
# Install all servers globally npx -y @modelcontextprotocol/server-memory
npm install -g @modelcontextprotocol/servers
# Or install individual servers
npm install -g @modelcontextprotocol/server-github
npm install -g @modelcontextprotocol/server-filesystem
# etc...
``` ```
### Usage This will start the [Memory](src/memory) server. However, this isn't very useful on its own, and should instead be configured into an MCP client. For example, here's the Claude Desktop configuration to use the above server:
Each server can be run directly from the command line: ```json
{
"mcpServers": {
"memory": {
"command": "npx",
"args": ["-y", "@modelcontextprotocol/server-memory"]
}
}
}
```
```bash Additional examples might look like:
mcp-server-github
mcp-server-filesystem ~/allowed/path ```json
mcp-server-postgres "postgresql://localhost/mydb" {
"mcpServers": {
"filesystem": {
"command": "npx",
"args": ["-y", "@modelcontextprotocol/server-filesystem", "/path/to/allowed/files"]
},
"github": {
"command": "npx",
"args": ["-y", "@modelcontextprotocol/server-github"],
"env": {
"GITHUB_PERSONAL_ACCESS_TOKEN": "<YOUR_TOKEN>"
}
},
"postgres": {
"command": "npx",
"args": ["-y", "@modelcontextprotocol/server-postgres", "postgresql://localhost/mydb"]
}
}
}
``` ```
## 🛠️ Creating Your Own Server ## 🛠️ Creating Your Own Server
Interested in creating your own MCP server? Visit the official documentation at [modelcontextprotocol.io/introduction](https://modelcontextprotocol.io/introduction) for comprehensive guides, best practices, and technical details on implementing MCP servers. Interested in creating your own MCP server? Visit the official documentation at [modelcontextprotocol.io](https://modelcontextprotocol.io/introduction) for comprehensive guides, best practices, and technical details on implementing MCP servers.
## 🤝 Contributing ## 🤝 Contributing
@ -58,7 +79,6 @@ This project is licensed under the MIT License - see the [LICENSE](LICENSE) file
## 💬 Community ## 💬 Community
- [Discord](https://discord.gg/modelcontextprotocol)
- [GitHub Discussions](https://github.com/modelcontextprotocol/servers/discussions) - [GitHub Discussions](https://github.com/modelcontextprotocol/servers/discussions)
## ⭐ Support ## ⭐ Support

View file

@ -1,6 +1,7 @@
{ {
"name": "@modelcontextprotocol/servers", "name": "@modelcontextprotocol/servers",
"version": "0.2.0", "private": true,
"version": "0.3.0",
"description": "Model Context Protocol servers", "description": "Model Context Protocol servers",
"license": "MIT", "license": "MIT",
"author": "Anthropic, PBC (https://anthropic.com)", "author": "Anthropic, PBC (https://anthropic.com)",
@ -14,7 +15,7 @@
"scripts": { "scripts": {
"build": "npm run build --workspaces", "build": "npm run build --workspaces",
"watch": "npm run watch --workspaces", "watch": "npm run watch --workspaces",
"publish-all": "npm publish --workspaces --access public && npm publish --access public", "publish-all": "npm publish --workspaces --access public",
"link-all": "npm link --workspaces" "link-all": "npm link --workspaces"
}, },
"dependencies": { "dependencies": {

View file

@ -37,10 +37,13 @@ An MCP server implementation that integrates the Brave Search API, providing bot
Add this to your `claude_desktop_config.json`: Add this to your `claude_desktop_config.json`:
```json ```json
"mcp-server-brave-search": { {
"command": "mcp-server-brave-search", "brave-search": {
"env": { "command": "npx",
"BRAVE_API_KEY": "YOUR_API_KEY_HERE" "args": ["-y", "@modelcontextprotocol/server-brave-search"],
"env": {
"BRAVE_API_KEY": "YOUR_API_KEY_HERE"
}
} }
} }
``` ```

View file

@ -82,8 +82,8 @@ Node.js server implementing Model Context Protocol (MCP) for filesystem operatio
Add this to your `claude_desktop_config.json`: Add this to your `claude_desktop_config.json`:
```json ```json
{ {
"mcp-server-filesystem": { "filesystem": {
"command": "mcp-server-filesystem", "command": "npx",
"args": ["Users/username/Desktop", "/path/to/other/allowed/dir"] "args": ["-y", "@modelcontextprotocol/server-filesystem", "/Users/username/Desktop", "/path/to/other/allowed/dir"]
} }
} }

View file

@ -51,7 +51,9 @@ To integrate this server with the desktop app, add the following to your app's s
```json ```json
{ {
"mcp-server-gdrive": { "gdrive": {
"command": "mcp-server-gdrive" "command": "npx",
"args": ["-y", "@modelcontextprotocol/server-gdrive"]
} }
} }
```

View file

@ -114,13 +114,15 @@ MCP Server for the GitHub API, enabling file operations, repository management,
### Usage with Claude Desktop ### Usage with Claude Desktop
To use this with Claude Desktop, add the following to your `claude_desktop_config.json`: To use this with Claude Desktop, add the following to your `claude_desktop_config.json`:
```json
{ ```json
"mcp-server-github": { {
"command": "mcp-server-github", "github": {
"env": { "command": "npx",
"GITHUB_PERSONAL_ACCESS_TOKEN": "<YOUR_TOKEN>" "args": ["-y", "@modelcontextprotocol/server-github"],
} "env": {
} "GITHUB_PERSONAL_ACCESS_TOKEN": "<YOUR_TOKEN>"
} }
``` }
}
```

View file

@ -55,11 +55,15 @@ MCP Server for the Google Maps API.
1. Get a Google Maps API key by following the instructions [here](https://developers.google.com/maps/documentation/javascript/get-api-key#create-api-keys). 1. Get a Google Maps API key by following the instructions [here](https://developers.google.com/maps/documentation/javascript/get-api-key#create-api-keys).
2. To use this with Claude Desktop, add the following to your `claude_desktop_config.json`: 2. To use this with Claude Desktop, add the following to your `claude_desktop_config.json`:
```json
"mcp-server-google-maps": { ```json
"command": "mcp-server-google-maps", {
"env": { "google-maps": {
"GOOGLE_MAPS_API_KEY": "<YOUR_API_KEY>" "command": "npx",
} "args": ["-y", "@modelcontextprotocol/server-google-maps"],
"env": {
"GOOGLE_MAPS_API_KEY": "<YOUR_API_KEY>"
} }
``` }
}
```

View file

@ -130,8 +130,9 @@ Example:
Add this to your claude_desktop_config.json: Add this to your claude_desktop_config.json:
```json ```json
{ {
"mcp-server-memory": { "memory": {
"command": "mcp-server-memory" "command": "npx",
"args": ["-y", "@modelcontextprotocol/server-memory"]
} }
} }
``` ```

View file

@ -25,9 +25,11 @@ The server provides schema information for each table in the database:
To use this server with the Claude Desktop app, add the following configuration to the "mcpServers" section of your `claude_desktop_config.json`: To use this server with the Claude Desktop app, add the following configuration to the "mcpServers" section of your `claude_desktop_config.json`:
```json ```json
"postgres": { {
"command": "mcp-server-postgres", "postgres": {
"args": ["postgresql://localhost/mydb"] "command": "npx",
"args": ["-y", "@modelcontextprotocol/server-postgres", "postgresql://localhost/mydb"]
}
} }
``` ```

View file

@ -93,18 +93,21 @@ MCP Server for the Slack API, enabling Claude to interact with Slack workspaces.
5. Get your Team ID (starts with a `T`) by following [this guidance](https://slack.com/help/articles/221769328-Locate-your-Slack-URL-or-ID#find-your-workspace-or-org-id) 5. Get your Team ID (starts with a `T`) by following [this guidance](https://slack.com/help/articles/221769328-Locate-your-Slack-URL-or-ID#find-your-workspace-or-org-id)
### Usage with the Claude Desktop app ### Usage with the Claude Desktop app
Add the following to your `claude_desktop_config.json`:
```json Add the following to your `claude_desktop_config.json`:
{
"mcp-server-slack": { ```json
"command": "mcp-server-slack", {
"env": { "slack": {
"SLACK_BOT_TOKEN": "xoxb-your-bot-token", "command": "npx",
"SLACK_TEAM_ID": "T01234567" "args": ["-y", "@modelcontextprotocol/server-slack"],
} "env": {
} "SLACK_BOT_TOKEN": "xoxb-your-bot-token",
} "SLACK_TEAM_ID": "T01234567"
``` }
}
}
```
### Troubleshooting ### Troubleshooting