summaryrefslogtreecommitdiff
path: root/README.md
blob: 4e470d6e142dbfee4707bbdbf60c317948d68fca (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
# Go MCP Servers

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

A pure Go implementation of Model Context Protocol (MCP) servers.

## Quick Start

### Installation

```bash
# Build all servers
make build

# Install to /usr/local/bin (requires sudo)
sudo make install
```

## Development

### Prerequisites

- Go
- Make

### Building

```bash
# Build all servers
make build
```

### Testing

```bash
# Run all tests
make test

# Run tests with coverage
make test-coverage

# Run specific server tests
go test ./pkg/git/...
go test ./pkg/filesystem/...
```

### Adding New Servers

1. Create a new directory under `cmd/`
2. Implement the server using the `pkg/mcp` package
3. Add comprehensive tests
5. Add build targets to Makefile

Each server is a standalone binary that communicates via JSON-RPC over
stdin/stdout, following the MCP specification. The modular package
structure allows for easy reuse and testing of server implementations.

## License

MIT License - see [LICENSE](LICENSE) file for details.

## Acknowledgments

- Inspired by the [Python MCP servers](https://github.com/modelcontextprotocol/servers)
- Follows the [Model Context Protocol](https://modelcontextprotocol.io/) specification