Skip to content

Commit

Permalink
Add docs for using with claude (#48)
Browse files Browse the repository at this point in the history
  • Loading branch information
Chrisbattarbee authored Dec 13, 2024
1 parent ffcdc99 commit d51afb6
Show file tree
Hide file tree
Showing 2 changed files with 32 additions and 1 deletion.
18 changes: 17 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,8 @@ Docs at [https://mcpgolang.com](https://mcpgolang.com)

## Example Usage

Install with `go get github.com/metoro-io/mcp-golang`

```go
package main

Expand Down Expand Up @@ -90,7 +92,21 @@ func main() {

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.

You can use raw go structs as the input to your tools, the library handles generating the messages, deserialization, etc.
### Using with Claude Desktop

Create a file in ~/Library/Application Support/Claude/claude_desktop_config.json with the following contents:

```json
{
"mcpServers": {
"golang-mcp-server": {
"command": "<your path to golang MCP server go executable>",
"args": [],
"env": {}
}
}
}
```

## Contributions

Expand Down
15 changes: 15 additions & 0 deletions docs/quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,21 @@ func main() {
}
```

### Using with Claude
Create a file in ~/Library/Application Support/Claude/claude_desktop_config.json with the following contents:

```json
{
"mcpServers": {
"golang-mcp-server": {
"command": "<your path to golang MCP server go executable>",
"args": [],
"env": {}
}
}
}
```

## Next Steps

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

0 comments on commit d51afb6

Please sign in to comment.