From 68d0fff84c672f74e9783062365ae27559ea15ac Mon Sep 17 00:00:00 2001 From: Michael Latman Date: Wed, 27 Nov 2024 00:08:30 -0500 Subject: [PATCH] Add license and README.md --- LICENSE | 21 +++++++++++++++++++++ README.md | 25 ++++++++++++++++++++++--- package-lock.json | 5 +++++ package.json | 6 ++++-- 4 files changed, 52 insertions(+), 5 deletions(-) create mode 100644 LICENSE diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..59647fc --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2024 Michael Latman + +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. \ No newline at end of file diff --git a/README.md b/README.md index 8ebedc6..7ce759e 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,31 @@ -# mcp-install +# mcp-get -## Project Description +A command-line tool for installing and managing Model Context Protocol (MCP) servers. -`mcp-get` is a command-line tool that allows you to install, list, and uninstall packages. It provides a convenient way to manage packages for your project. +## About Model Context Protocol + +The Model Context Protocol (MCP) is an open protocol that enables seamless integration between LLM applications and external data sources and tools. Whether you're building an AI-powered IDE, enhancing a chat interface, or creating custom AI workflows, MCP provides a standardized way to connect LLMs with the context they need. + +Learn more about MCP at [modelcontextprotocol.io](https://modelcontextprotocol.io/introduction) + +## What Packages Can You Install? + +This tool helps you install and manage MCP servers that connect Claude to various data sources and tools, including: + +- **Development Tools**: GitHub, GitLab +- **Communication Tools**: Slack +- **Search & Data**: Brave Search, Google Maps +- **Database Systems**: PostgreSQL +- **Web Automation**: Puppeteer +- **Cloud Storage**: Google Drive ## Prerequisites - Node.js (version 14 or higher) +- Claude Desktop app (for local MCP server usage) + +> **Note**: This tool has not been thoroughly tested on Windows systems yet. While it may work, you might encounter some issues. Contributions to improve Windows compatibility are welcome! + ## Usage Examples diff --git a/package-lock.json b/package-lock.json index 6a91358..5d915b2 100644 --- a/package-lock.json +++ b/package-lock.json @@ -6,7 +6,12 @@ "packages": { "": { "name": "@michaellatman/mcp-get", +<<<<<<< HEAD "version": "1.0.1", +======= + "version": "1.0.0", + "license": "MIT", +>>>>>>> 21d7d5c (Add license and README.md) "dependencies": { "chalk": "^4.1.2", "cli-table3": "^0.6.5", diff --git a/package.json b/package.json index 08ea15a..bfda413 100644 --- a/package.json +++ b/package.json @@ -41,12 +41,14 @@ "dist", "README.md", "package.json", - "packages" + "packages", + "LICENSE" ], "type": "module", "exports": { ".": { "import": "./dist/index.js" } - } + }, + "license": "MIT" }