diff options
| author | mo khan <mo@mokhan.ca> | 2025-08-18 14:30:29 -0600 |
|---|---|---|
| committer | mo khan <mo@mokhan.ca> | 2025-08-18 14:30:29 -0600 |
| commit | e90b8975e5e6b7c1dafd7fca441f596d9994b71d (patch) | |
| tree | 9dfe9bd6bd1802275ca579e478887d62d91c0e09 | |
| parent | 77bd3b042609426fa0bd5ccd13225a5762bafbc0 (diff) | |
docs: update README.md
| -rw-r--r-- | README.md | 32 |
1 files changed, 3 insertions, 29 deletions
@@ -2,17 +2,13 @@ [](https://opensource.org/licenses/MIT) -A pure Go implementation of Model Context Protocol (MCP) servers, providing drop-in replacements for the Python MCP servers with zero dependencies and static linking. +A pure Go implementation of Model Context Protocol (MCP) servers. ## Quick Start ### Installation ```bash -# Clone the repository -git clone https://github.com/xlgmokha/mcp.git -cd mcp - # Build all servers make build @@ -24,8 +20,8 @@ sudo make install ### Prerequisites -- Go 1.21 or later (requires Go 1.24 for current build) -- Make (optional, for convenience) +- Go +- Make ### Building @@ -48,22 +44,11 @@ go test ./pkg/git/... go test ./pkg/filesystem/... ``` -### Code Quality - -```bash -# Check code quality -go vet ./... -gofmt -l . - -# Note: golangci-lint has issues with Go 1.24, use go vet instead -``` - ### Adding New Servers 1. Create a new directory under `cmd/` 2. Implement the server using the `pkg/mcp` package 3. Add comprehensive tests -4. Update this README 5. Add build targets to Makefile Each server is a standalone binary that communicates via JSON-RPC over @@ -74,17 +59,6 @@ structure allows for easy reuse and testing of server implementations. MIT License - see [LICENSE](LICENSE) file for details. -## Contributing - -We welcome contributions! Please see [CONTRIBUTING.md](CONTRIBUTING.md) for detailed guidelines. - -Quick start: -1. Fork the repository -2. Create a feature branch -3. Add tests for new functionality -4. Ensure all tests pass: `make test` -5. Submit a pull request - ## Acknowledgments - Inspired by the [Python MCP servers](https://github.com/modelcontextprotocol/servers) |
