Updates + Merge

This commit is contained in:
Garvan
2024-11-21 12:42:01 -05:00
parent b0df6dabe8
commit 9ed413353d
8 changed files with 760 additions and 221 deletions

View File

@@ -1,21 +1,73 @@
# MCP servers ![NPM Version](https://img.shields.io/npm/v/%40modelcontextprotocol%2Fexample-servers)
Example servers for the Model Context Protocol, to demonstrate the kinds of things you can do!
[![MIT License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
## Getting started
A collection of reference implementations and community-contributed servers for the Model Context Protocol (MCP). This repository showcases the versatility and extensibility of MCP, demonstrating how it can be used to give Large Language Models (LLMs) secure, controlled access to external tools and data sources.
Install from npm:
## 🌟 Featured Servers
```sh
- **[Filesystem](src/filesystem)** - Secure file operations with configurable access controls
- **[GitHub](src/github)** - Repository management, file operations, and GitHub API integration
- **[Google Drive](src/gdrive)** - File access and search capabilities for Google Drive
- **[PostgreSQL](src/postgres)** - Read-only database access with schema inspection
- **[Slack](src/slack)** - Channel management and messaging capabilities
- **[Memory](src/memory)** - Knowledge graph-based persistent memory system
- **[Puppeteer](src/puppeteer)** - Browser automation and web scraping
- **[Brave Search](src/brave-search)** - Web and local search using Brave's API
- **[Google Maps](src/google-maps)** - Location services, directions, and place details
## 🚀 Getting Started
### Installation
```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...
```
Then, the servers will be globally available on your PATH:
### Usage
```sh
mcp-server-everything
mcp-server-postgres
# ...
Each server can be run directly from the command line:
```bash
mcp-server-github
mcp-server-filesystem ~/allowed/path
mcp-server-postgres "postgresql://localhost/mydb"
```
Each server will operate differently. See the READMEs within [src](src/) for more information.
## 🛠️ 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.
## 🤝 Contributing
See [CONTRIBUTING.md](CONTRIBUTING.md) for information about contributing to the MCP servers repository.
## 🔒 Security
See [SECURITY.md](SECURITY.md) for reporting security vulnerabilities.
## 📜 License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
## 💬 Community
- [Discord](https://discord.gg/modelcontextprotocol)
- [GitHub Discussions](https://github.com/modelcontextprotocol/servers/discussions)
## ⭐ Support
If you find MCP servers useful, please consider:
- Starring the repository
- Contributing new servers or improvements
- Sharing your experience with the community
---
Managed by Anthropic, but built together with the community. The Model Context Protocol is open source and we encourage everyone to contribute their own servers and improvements!