alihan/model-context-protocol-servers
1
0
Fork 0
mirror of https://github.com/modelcontextprotocol/servers.git synced 2024-12-01 18:58:34 +03:00
Code Issues Packages Projects Releases Wiki Activity

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

Browse Source 
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
parent 5d322cbae6 7238146c2a
commit 9b1571cf2f
10 changed files with 103 additions and 65 deletions
Download Patch File Download Diff File Expand all files Collapse all files

54
README.md
View File

@@ -18,31 +18,52 @@ A collection of reference implementations and community-contributed servers for
## 🚀 Getting Started
### Installation
The servers in this repository can be used directly with `npx`. For example:
```bash
# Install all servers globally
npm install -g @modelcontextprotocol/servers
# Or install individual servers
npm install -g @modelcontextprotocol/server-github
npm install -g @modelcontextprotocol/server-filesystem
# etc...
```sh
npx -y @modelcontextprotocol/server-memory
```
### 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
mcp-server-github
mcp-server-filesystem ~/allowed/path
mcp-server-postgres "postgresql://localhost/mydb"
Additional examples might look like:
```json
{
"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
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
@@ -58,7 +79,6 @@ This project is licensed under the MIT License - see the [LICENSE](LICENSE) file
## 💬 Community
- [Discord](https://discord.gg/modelcontextprotocol)
- [GitHub Discussions](https://github.com/modelcontextprotocol/servers/discussions)
## ⭐ Support

5
package.json
View File

@@ -1,6 +1,7 @@
{
"name": "@modelcontextprotocol/servers",
"version": "0.2.0",
"private": true,
"version": "0.3.0",
"description": "Model Context Protocol servers",
"license": "MIT",
"author": "Anthropic, PBC (https://anthropic.com)",
@@ -14,7 +15,7 @@
"scripts": {
"build": "npm run build --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"
},
"dependencies": {

11
src/brave-search/README.md
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`:
```json
"mcp-server-brave-search": {
"command": "mcp-server-brave-search",
"env": {
"BRAVE_API_KEY": "YOUR_API_KEY_HERE"
{
"brave-search": {
"command": "npx",
"args": ["-y", "@modelcontextprotocol/server-brave-search"],
"env": {
"BRAVE_API_KEY": "YOUR_API_KEY_HERE"
}
}
}
```

6
src/filesystem/README.md
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`:
```json
{
"mcp-server-filesystem": {
"command": "mcp-server-filesystem",
"args": ["Users/username/Desktop", "/path/to/other/allowed/dir"]
"filesystem": {
"command": "npx",
"args": ["-y", "@modelcontextprotocol/server-filesystem", "/Users/username/Desktop", "/path/to/other/allowed/dir"]
}
}

8
src/gdrive/README.md
View File

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

22
src/github/README.md
View File

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

18
src/google-maps/README.md
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).
2. To use this with Claude Desktop, add the following to your `claude_desktop_config.json`:
```json
"mcp-server-google-maps": {
"command": "mcp-server-google-maps",
"env": {
"GOOGLE_MAPS_API_KEY": "<YOUR_API_KEY>"
}
```json
{
"google-maps": {
"command": "npx",
"args": ["-y", "@modelcontextprotocol/server-google-maps"],
"env": {
"GOOGLE_MAPS_API_KEY": "<YOUR_API_KEY>"
}
```
}
}
```

7
src/memory/README.md
View File

@@ -130,8 +130,9 @@ Example:
Add this to your claude_desktop_config.json:
```json
{
"mcp-server-memory": {
"command": "mcp-server-memory"
"memory": {
"command": "npx",
"args": ["-y", "@modelcontextprotocol/server-memory"]
}
}
```
@@ -166,4 +167,4 @@ Follow these steps for each interaction:
a) Create entities for recurring organizations, people, and significant events
b) Connect them to the current entities using relations
b) Store facts about them as observations
```
```

8
src/postgres/README.md
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`:
```json
"postgres": {
"command": "mcp-server-postgres",
"args": ["postgresql://localhost/mydb"]
{
"postgres": {
"command": "npx",
"args": ["-y", "@modelcontextprotocol/server-postgres", "postgresql://localhost/mydb"]
}
}
```

29
src/slack/README.md
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)
### Usage with the Claude Desktop app
Add the following to your `claude_desktop_config.json`:
```json
{
"mcp-server-slack": {
"command": "mcp-server-slack",
"env": {
"SLACK_BOT_TOKEN": "xoxb-your-bot-token",
"SLACK_TEAM_ID": "T01234567"
}
}
}
```
Add the following to your `claude_desktop_config.json`:
```json
{
"slack": {
"command": "npx",
"args": ["-y", "@modelcontextprotocol/server-slack"],
"env": {
"SLACK_BOT_TOKEN": "xoxb-your-bot-token",
"SLACK_TEAM_ID": "T01234567"
}
}
}
```
### Troubleshooting
@@ -112,4 +115,4 @@ If you encounter permission errors, verify that:
1. All required scopes are added to your Slack app
2. The app is properly installed to your workspace
3. The tokens and workspace ID are correctly copied to your configuration
4. The app has been added to the channels it needs to access
4. The app has been added to the channels it needs to access