From d51afb6a80da9d65b0e0fd2c310e81f4df1f3e65 Mon Sep 17 00:00:00 2001 From: Chris Battarbee Date: Fri, 13 Dec 2024 11:26:21 +0000 Subject: [PATCH] Add docs for using with claude (#48) --- README.md | 18 +++++++++++++++++- docs/quickstart.mdx | 15 +++++++++++++++ 2 files changed, 32 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 4acc2e3..8f05f6e 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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": "", + "args": [], + "env": {} + } + } +} +``` ## Contributions diff --git a/docs/quickstart.mdx b/docs/quickstart.mdx index a33fbd0..76d9f94 100644 --- a/docs/quickstart.mdx +++ b/docs/quickstart.mdx @@ -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": "", + "args": [], + "env": {} + } + } +} +``` + ## Next Steps - If you're interested in contributing to mcp-golang, check out [Development Guide](/development) for more detailed information