Skip to content

Commit d51afb6

Browse files
Add docs for using with claude (#48)
1 parent ffcdc99 commit d51afb6

File tree

2 files changed

+32
-1
lines changed

2 files changed

+32
-1
lines changed

README.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,8 @@ Docs at [https://mcpgolang.com](https://mcpgolang.com)
3636

3737
## Example Usage
3838

39+
Install with `go get github.com/metoro-io/mcp-golang`
40+
3941
```go
4042
package main
4143

@@ -90,7 +92,21 @@ func main() {
9092

9193
This will start a server using the stdio transport (used by claude desktop), host a tool called "hello" that will say hello to the user who submitted it.
9294

93-
You can use raw go structs as the input to your tools, the library handles generating the messages, deserialization, etc.
95+
### Using with Claude Desktop
96+
97+
Create a file in ~/Library/Application Support/Claude/claude_desktop_config.json with the following contents:
98+
99+
```json
100+
{
101+
"mcpServers": {
102+
"golang-mcp-server": {
103+
"command": "<your path to golang MCP server go executable>",
104+
"args": [],
105+
"env": {}
106+
}
107+
}
108+
}
109+
```
94110

95111
## Contributions
96112

docs/quickstart.mdx

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,21 @@ func main() {
6868
}
6969
```
7070

71+
### Using with Claude
72+
Create a file in ~/Library/Application Support/Claude/claude_desktop_config.json with the following contents:
73+
74+
```json
75+
{
76+
"mcpServers": {
77+
"golang-mcp-server": {
78+
"command": "<your path to golang MCP server go executable>",
79+
"args": [],
80+
"env": {}
81+
}
82+
}
83+
}
84+
```
85+
7186
## Next Steps
7287

7388
- If you're interested in contributing to mcp-golang, check out [Development Guide](/development) for more detailed information

0 commit comments

Comments
 (0)