MCP-Golang 项目使用与启动教程

MCP-Golang 项目使用与启动教程

mcp-golang Write Model Context Protocol servers in few lines of go code. Docs at https://mcpgolang.com 项目地址: https://gitcode.com/gh_mirrors/mc/mcp-golang

1. 项目目录结构及介绍

MCP-Golang 是一个用于编写 Model Context Protocol (MCP) 服务器和客户端的 Go 语言库。项目的目录结构如下：

• .github/: 存放 GitHub Actions 工作流配置文件。
• docs/: 项目文档。
• examples/: 包含使用 MCP-Golang 的示例代码。
• internal/: 内部使用的包和工具。
• resources/: 存储项目相关资源。
• transport/: 实现不同传输方式的包。
• .cursorrules: 用于编辑器光标规则定义的文件。
• .gitignore: 定义 Git 忽略的文件和目录。
• .goreleaser.yml: GoReleaser 的配置文件，用于自动化发布。
• CONTRIBUTING.md: 贡献指南。
• LICENSE: 项目许可证文件。
• README.md: 项目说明文件。
• client.go: 客户端实现的示例代码。
• content_api.go: 内容 API 相关代码。
• go.mod: Go 模块定义文件。
• go.sum: Go 模块的依赖摘要文件。
• integration_test.go: 集成测试代码。
• prompt_api.go: 提示 API 相关代码。
• prompt_response_types.go: 提示响应类型定义。
• resource_api.go: 资源 API 相关代码。
• resource_response_types.go: 资源响应类型定义。
• server.go: 服务器实现的示例代码。
• server_test.go: 服务器测试代码。
• tool_api.go: 工具 API 相关代码。
• tool_response_types.go: 工具响应类型定义。

2. 项目的启动文件介绍

项目的启动文件通常位于 main.go 中。以下是一个简单的服务器启动示例：

package main

import (
    "fmt"
    "github.com/metoro-io/mcp-golang"
    "github.com/metoro-io/mcp-golang/transport/stdio"
)

type Content struct {
    Title       string `json:"title" jsonschema:"required,description=The title to submit"`
    Description *string `json:"description" jsonschema:"description=The description to submit"`
}

type MyFunctionsArguments struct {
    Submitter string `json:"submitter" jsonschema:"required,description=The name of the thing calling this tool (openai, google, claude, etc)"`
    Content   Content `json:"content" jsonschema:"required,description=The content of the message"`
}

func main() {
    server := mcp_golang.NewServer(stdio.NewStdioServerTransport())
    // 注册工具、提示和资源...
    err := server.Serve()
    if err != nil {
        panic(err)
    }
}

在这个文件中，我们创建了一个 MCP 服务器实例，注册了相关的工具和提示，然后调用 Serve() 方法启动服务器。

3. 项目的配置文件介绍

MCP-Golang 项目中的配置文件通常是 config.json 或 .env 文件，用于存储项目的配置信息。在这个项目中，配置文件的示例可能如下：

{
    "port": 8080,
    "resources": {
        "test": {
            "url": "test://resource",
            "type": "application/json"
        }
    }
}

在这个配置文件中，我们定义了服务器监听的端口和资源的相关信息。具体配置文件的格式和内容可能会根据项目的具体需求而有所不同。

在编写配置文件时，请确保所有配置项都按照项目的实际需求进行设置，并在代码中相应地加载和应用这些配置。

mcp-golang Write Model Context Protocol servers in few lines of go code. Docs at https://mcpgolang.com 项目地址: https://gitcode.com/gh_mirrors/mc/mcp-golang