Skip to content

Commit

Permalink
Merge pull request #23 from modelcontextprotocol/justin/remove-top-pa…
Browse files Browse the repository at this point in the history
…ckage

Don't publish umbrella package anymore
  • Loading branch information
jspahrsummers authored Nov 21, 2024
2 parents 5d322cb + 7238146 commit 9b1571c
Show file tree
Hide file tree
Showing 10 changed files with 104 additions and 66 deletions.
56 changes: 38 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Each server can be run directly from the command line:
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:

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

Expand All @@ -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
Expand Down
5 changes: 3 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
@@ -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)",
Expand All @@ -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": {
Expand Down
11 changes: 7 additions & 4 deletions src/brave-search/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 changes: 3 additions & 3 deletions src/filesystem/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 changes: 5 additions & 3 deletions src/gdrive/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 changes: 12 additions & 10 deletions src/github/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 changes: 11 additions & 7 deletions src/google-maps/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 changes: 4 additions & 3 deletions src/memory/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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"]
}
}
```
Expand Down Expand Up @@ -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 changes: 5 additions & 3 deletions src/postgres/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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"]
}
}
```

Expand Down
29 changes: 16 additions & 13 deletions src/slack/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,23 +93,26 @@ 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

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

0 comments on commit 9b1571c

Please sign in to comment.