From 9ee16f21bccfe00899db045112534018e469c402 Mon Sep 17 00:00:00 2001 From: Frank Date: Sat, 11 Jan 2025 21:10:36 +1100 Subject: [PATCH] add outline --- CONTRIBUTING.md | 45 +++++++++++++++++++++++++++++++++++++++++++++ LICENSE | 25 +++++++++++++++++++++++++ README.md | 26 ++++++++++++++++++++++++++ 3 files changed, 96 insertions(+) create mode 100644 CONTRIBUTING.md create mode 100644 LICENSE create mode 100644 README.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..7aed34d --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,45 @@ +# Contributing to Awesome MCP Servers + +Contributions are welcome and encouraged! Whether you're fixing a typo, adding a new client, or suggesting improvements, your help is appreciated. + +## How to Contribute + +1. **Fork the repository:** Click the "Fork" button in the top right corner of the GitHub page. + +2. **Create a new branch:** Create a new branch for your changes. This keeps your changes separate from the main project until they're ready to be merged. A good branch name describes the changes you're making, e.g., `add-new-client` or `fix-typo`. + + ```bash + git checkout -b add-new-client + ``` + +3. **Make your changes:** Edit the `README.md` file with your additions or corrections. Please follow the existing format and style. When adding a new client, make sure to include: + + * The client name, linked to its repository/website. + * A brief description of the client's functionality. + +4. **Commit your changes:** Commit your changes with a clear and concise message explaining what you've done. + + ```bash + git commit -m "Add new XYZ client" + ``` + +5. **Push your branch:** Push your branch to your forked repository. + + ```bash + git push origin add-new-client + ``` + +6. **Create a pull request:** Go to the original repository and click the "New pull request" button. Select your forked repository and branch. Provide a clear title and description of your changes in the pull request. + +7. **Review and merge:** Your pull request will be reviewed by the maintainers. They may suggest changes or ask for clarification. Once the review is complete, your changes will be merged into the main project. + + +## Guidelines + +* **Keep it consistent:** Follow the existing format and style of the `README.md` file. This includes formatting, capitalization, and punctuation. +* **Alphabetical order:** Maintain alphabetical order within each category of clients. This makes it easier to find specific clients. +* **Accurate information:** Ensure that all information is accurate and up-to-date. Double-check links and descriptions before submitting your changes. +* **One client per line:** List each client on a separate line for better readability. +* **Clear descriptions:** Write concise and informative descriptions for each client. Explain what the client does and what its key features are. + +Thank you for contributing! diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..eb830bd --- /dev/null +++ b/LICENSE @@ -0,0 +1,25 @@ +The MIT License (MIT) +===================== + +Copyright © 2025 Frank Fiegel (frank@glama.ai) + +Permission is hereby granted, free of charge, to any person +obtaining a copy of this software and associated documentation +files (the “Software”), to deal in the Software without +restriction, including without limitation the rights to use, +copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the +Software is furnished to do so, subject to the following +conditions: + +The above copyright notice and this permission notice shall be +included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, +EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES +OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT +HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, +WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING +FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR +OTHER DEALINGS IN THE SOFTWARE. diff --git a/README.md b/README.md new file mode 100644 index 0000000..8ffdedb --- /dev/null +++ b/README.md @@ -0,0 +1,26 @@ +# Awesome MCP Clients [![Awesome](https://awesome.re/badge.svg)](https://awesome.re) + +[![Discord](https://img.shields.io/discord/1312302100125843476?logo=discord&label=discord)](https://glama.ai/mcp/discord) +[![Subreddit subscribers](https://img.shields.io/reddit/subreddit-subscribers/mcp?style=flat&logo=reddit&label=subreddit)](https://www.reddit.com/r/mcp/) + +A curated list of awesome Model Context Protocol (MCP) clients. + +* [What is MCP?](#what-is-mcp) +* [Community](#community) +* [Clients](#clients) +* [Servers](#servers) + +## What is MCP? + +[MCP](https://modelcontextprotocol.io/) is an open protocol that enables AI models to securely interact with local and remote resources through standardized server implementations. This list focuses on production-ready and experimental MCP servers that extend AI capabilities through file access, database connections, API integrations, and other contextual services. + +## Community + +* [r/mcp Reddit](https://www.reddit.com/r/mcp) +* [Discord Server](https://glama.ai/mcp/discord) + +## Clients + +## Servers + +Looking for MCP servers? Check out the [awesome-mcp-servers](https://github.com/punkpeye/awesome-mcp-servers) repository. \ No newline at end of file