Skip to content

Add docs for using with claude #48

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
Loading