Added README.md, Contributing.md, pull_request_template.md

modelcontextprotocol · Nov 21, 2024 · b5acef3 · b5acef3
1 parent ae8c82c
commit b5acef3
Show file tree

Hide file tree

Showing 3 changed files with 33 additions and 80 deletions.
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
@@ -1,31 +1,30 @@
-<!-- Provide a brief description of your changes -->
-
 ## Description
+*Provide a brief description of your changes*
 
 ## Server Details
-<!-- If modifying an existing server or adding a new one, provide details -->
-- Server: <!-- e.g., filesystem, github, new-server-name -->
-- Changes to: <!-- e.g., tools, resources, prompts -->
+*If modifying an existing server or adding a new one, provide details:*
+- Server: *(e.g., filesystem, github, new-server-name)*
+- Changes to: *(e.g., tools, resources, prompts)*
 
 ## Motivation and Context
-<!-- Why is this change needed? What problem does it solve? -->
+*Why is this change needed? What problem does it solve?*
 
 ## How Has This Been Tested?
-<!-- Have you tested this with an LLM client? Which scenarios were tested? -->
+*Have you tested this with an LLM client? Which scenarios were tested?*
 
 ## Breaking Changes
-<!-- Will users need to update their MCP client configurations? -->
+*Will users need to update their MCP client configurations?*
 
 ## Types of changes
-<!-- What types of changes does your code introduce? Put an `x` in all the boxes that apply: -->
+*What types of changes does your code introduce? Put an `x` in all the boxes that apply:*
 - [ ] New MCP Server
 - [ ] Bug fix (non-breaking change which fixes an issue)
 - [ ] New feature (non-breaking change which adds functionality)
 - [ ] Breaking change (fix or feature that would cause existing functionality to change)
 - [ ] Documentation update
 
 ## Checklist
-<!-- Go over all the following points, and put an `x` in all the boxes that apply. -->
+*Go over all the following points, and put an `x` in all the boxes that apply:*
 - [ ] I have read the [MCP Protocol Documentation](https://modelcontextprotocol.io)
 - [ ] My server follows MCP security best practices
 - [ ] I have updated the server's README accordingly
@@ -36,4 +35,4 @@
 - [ ] I have documented all environment variables and configuration options
 
 ## Additional context
-<!-- Add any other context, implementation notes, or design decisions -->
+*Add any other context, implementation notes, or design decisions*
diff --git a/.github/CONTRIBUTING.md → CONTRIBUTING.md b/.github/CONTRIBUTING.md → CONTRIBUTING.md
@@ -29,22 +29,6 @@ Documentation improvements are always welcome:
 - Improving setup instructions
 - Adding troubleshooting guides
 
-## Getting Started
-
-1. Fork the repository
-2. Clone your fork:
-   ```bash
-   git clone https://github.com/your-username/mcp-servers.git
-   ```
-3. Add the upstream remote:
-   ```bash
-   git remote add upstream https://github.com/modelcontextprotocol/servers.git
-   ```
-4. Create a branch:
-   ```bash
-   git checkout -b my-feature
-   ```
-
 ## Development Guidelines
 
 ### Code Style
@@ -55,33 +39,8 @@ Documentation improvements are always welcome:
 
 ### Documentation
 - Include a detailed README.md in your server directory
-- Document all configuration options
-- 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
-- Handle errors appropriately
-- Document security considerations
-
-## Submitting Changes
-
-1. Commit your changes:
-   ```bash
-   git add .
-   git commit -m "Description of changes"
-   ```
-2. Push to your fork:
-   ```bash
-   git push origin my-feature
-   ```
-3. Create a Pull Request through GitHub
+- Document each Tool, Resource, and Prompt
+
 
 ### Pull Request Guidelines
 
@@ -103,9 +62,12 @@ Documentation improvements are always welcome:
 - Participate in [GitHub Discussions](https://github.com/modelcontextprotocol/servers/discussions)
 - Follow the [Code of Conduct](CODE_OF_CONDUCT.md)
 
+
 ## Questions?
 
 - Check the [documentation](https://modelcontextprotocol.io)
 - Ask in GitHub Discussions
 
-Thank you for contributing to MCP Servers!
+## License
+
+By contributing, you agree that your contributions will be licensed under the MIT License.
diff --git a/README.md b/README.md
@@ -8,7 +8,7 @@ A collection of reference implementations and community-contributed servers for
 ## 🌟 Featured Servers
 
 - **[SQLite](src/sqlite)** - Read and Write access to a local SQLite database with a helpful demo prompt to get started
-- **[Filesystem](src/filesystem)** - Secure file operations with configurable access controls
+- **[Filesystem](src/filesystem)** -  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
@@ -22,7 +22,7 @@ A collection of reference implementations and community-contributed servers for
 ## 🚀 Getting Started
 
 ### Installation
-
+1. Install Servers
 ```bash
 # Install all servers globally
 npm install -g @modelcontextprotocol/servers
@@ -32,35 +32,28 @@ npm install -g @modelcontextprotocol/server-github
 npm install -g @modelcontextprotocol/server-filesystem
 # etc...
 ```
+2. Configure Client (Claude Desktop)
+```bash
+# Open the claude_desktop_config.json
+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.
+{
+  "mcpServers": {}
+}
+# Add the above servers and associated commands
+{
+  "mcpServers": {}
+}
+```
+
+
 
 ## 🛠️ 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
 
-We welcome contributions from the community! Whether you're fixing bugs, adding features to existing servers, or creating entirely new ones, here's how to contribute:
-
-1. **Fork & Clone**:
-   ```bash
-   git clone https://github.com/your-username/mcp-servers.git
-   cd mcp-servers
-   ```
-
-2. **Install Dependencies**:
-   ```bash
-   npm install
-   ```
-
-3. **Create Your Server**:
-   - Add your server in `src/your-server-name/`
-   - Include a comprehensive README.md
-   - Follow the implementation guidelines from [modelcontextprotocol.io](https://modelcontextprotocol.io)
-
-4. **Submit a Pull Request**:
-   - Describe your changes in detail
-   - Reference any related issues
-   - Follow the existing code style
+See [CONTRIBUTING.md](CONTRIBUTING.md) for information about how you can contribute to the MCP servers repository.
 
 ## 🔒 Security
 
@@ -72,7 +65,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