Skip to content

Commit

Permalink
Merge pull request #25 from modelcontextprotocol/mahesh/readme-edits
Browse files Browse the repository at this point in the history
Minor README nits
  • Loading branch information
maheshmurag authored Nov 22, 2024
2 parents ba35422 + a25d94d commit 8e63b5e
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 29 deletions.
20 changes: 4 additions & 16 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,20 +5,19 @@ Thank you for your interest in contributing to the Model Context Protocol (MCP)
## Types of Contributions

### 1. New Servers
Adding new servers is one of the most valuable ways to contribute. Before creating a new server:
Adding a new server is a valuable way to contribute. Before creating a new server:

- Check the [modelcontextprotocol.io](https://modelcontextprotocol.io) documentation
- Ensure your server doesn't duplicate existing functionality
- Consider whether your server would be generally useful to others
- Follow security best practices from the MCP documentation
- Follow [security best practices](https://modelcontextprotocol.io/docs/concepts/transports#security-considerations) from the MCP documentation

### 2. Improvements to Existing Servers
Enhancements to existing servers are welcome! This includes:

- Bug fixes
- Performance improvements
- New features
- Documentation improvements
- Security enhancements

### 3. Documentation
Expand All @@ -34,7 +33,7 @@ Documentation improvements are always welcome:
1. Fork the repository
2. Clone your fork:
```bash
git clone https://github.com/your-username/mcp-servers.git
git clone https://github.com/your-username/servers.git
```
3. Add the upstream remote:
```bash
Expand All @@ -49,7 +48,6 @@ Documentation improvements are always welcome:

### Code Style
- Follow the existing code style in the repository
- Use TypeScript for JavaScript/Node.js servers
- Include appropriate type definitions
- Add comments for complex logic

Expand All @@ -59,11 +57,6 @@ Documentation improvements are always welcome:
- Provide setup instructions
- Include usage examples

### Testing
- Add appropriate tests for new functionality
- Ensure existing tests pass
- Test your changes thoroughly

### Security
- Follow security best practices
- Implement proper input validation
Expand All @@ -85,19 +78,14 @@ Documentation improvements are always welcome:

### Pull Request Guidelines

- Thoroughly test your changes
- Fill out the pull request template completely
- Link any related issues
- Provide clear description of changes
- Include any necessary documentation updates
- Add screenshots for UI changes
- List any breaking changes

## Review Process

1. Maintainers will review your PR
2. Address any requested changes
3. Once approved, your PR will be merged

## Community

- Participate in [GitHub Discussions](https://github.com/modelcontextprotocol/servers/discussions)
Expand Down
11 changes: 4 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# MCP servers

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.
A collection of reference implementations and community-contributed servers for the [Model Context Protocol](https://modelcontextprotocol.io/) (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 tools and data sources.

## 🌟 Featured Servers

Expand All @@ -11,7 +11,7 @@ A collection of reference implementations and community-contributed servers for
- **[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
- **[Brave Search](src/brave-search)** - Web and local search using Brave's Search API
- **[Google Maps](src/google-maps)** - Location services, directions, and place details

## 🚀 Getting Started
Expand Down Expand Up @@ -65,7 +65,7 @@ Interested in creating your own MCP server? Visit the official documentation at

## 🤝 Contributing

See [CONTRIBUTING.md](CONTRIBUTING.md) for information about contributing to the MCP servers repository.
See [CONTRIBUTING.md](CONTRIBUTING.md) for information about contributing to this repository.

## 🔒 Security

Expand All @@ -81,10 +81,7 @@ This project is licensed under the MIT License - see the [LICENSE](LICENSE) file

## ⭐ Support

If you find MCP servers useful, please consider:
- Starring the repository
- Contributing new servers or improvements
- Sharing your experience with the community
If you find MCP servers useful, please consider starring the repository and contributing new servers or improvements!

---

Expand Down
8 changes: 2 additions & 6 deletions SECURITY.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,10 @@
# Security Policy
Thank you for helping us keep our MCP servers secure.

## Reporting Security Issues

These servers are maintained by [Anthropic](https://www.anthropic.com/) as part of the Model Context Protocol project.
These servers are maintained by [Anthropic](https://www.anthropic.com/) as part of the Model Context Protocol project.

The security of our systems and user data is Anthropic’s top priority. We appreciate the work of security researchers acting in good faith in identifying and reporting potential vulnerabilities.

Our security program is managed on HackerOne and we ask that any validated vulnerability in this functionality be reported through their [submission form](https://hackerone.com/anthropic-vdp/reports/new?type=team&report_type=vulnerability).

## Vulnerability Disclosure Program

Our Vulnerability Program Guidelines are defined on our [HackerOne program page](https://hackerone.com/anthropic-vdp).
Our Vulnerability Program guidelines are defined on our [HackerOne program page](https://hackerone.com/anthropic-vdp). We ask that any validated vulnerability in this functionality be reported through the [submission form](https://hackerone.com/anthropic-vdp/reports/new?type=team&report_type=vulnerability).

0 comments on commit 8e63b5e

Please sign in to comment.