README
🚀 Ergs MCP 服务器
Ergs MCP 服务器是一个模型上下文协议(MCP)服务器,它提供了与 Ergs API 进行交互的工具。该服务器使 AI 助手和其他 MCP 客户端能够通过 Ergs 网络 API 搜索和浏览你的数据源。
🚀 快速开始
使用 Ergs MCP 服务器前,你需要完成一些准备工作,并进行安装和配置。
✨ 主要特性
- 提供与 Ergs API 交互的工具,让 AI 助手和 MCP 客户端能搜索和浏览数据源。
- 支持从源码构建和使用 Go Install 进行安装。
- 可通过环境变量配置连接的 Ergs 网络服务器。
📦 安装指南
从源码构建
git clone https://github.com/rubiojr/ergs-mcp
cd ergs-mcp
go build -o ergs-mcp
使用 Go Install
go install github.com/rubiojr/ergs-mcp@latest
💻 使用示例
基础用法
启动 Ergs 网络服务器
首先,确保你的 Ergs 网络服务器正在运行:
ergs web --port 8080
运行 MCP 服务器
启动 MCP 服务器:
./ergs-mcp
服务器将使用 MCP 协议通过标准输入输出进行通信。
MCP 客户端配置
Claude Desktop
在你的 Claude Desktop 配置文件(macOS 上为 ~/Library/Application Support/Claude/claude_desktop_config.json)中添加以下内容:
{
"mcpServers": {
"ergs": {
"command": "/path/to/ergs-mcp",
"env": {
"ERGS_URL": "http://localhost:8080"
}
}
}
}
Zed Editor
在你的 Zed 设置文件(Linux 上为 ~/.config/zed/settings.json,macOS 上为 ~/Library/Application Support/Zed/settings.json)中添加以下内容:
{
"context_servers": {
"ergs": {
"command": {
"path": "/absolute/path/to/ergs-mcp",
"args": [],
"env": {
"ERGS_URL": "http://localhost:8080"
}
}
}
}
}
请确保将 /absolute/path/to/ergs-mcp 替换为你实际构建的二进制文件的路径。
其他 MCP 客户端
配置你的 MCP 客户端以执行 ergs-mcp 二进制文件并通过标准输入输出进行通信。
高级用法
构建
go build -o ergs-mcp
测试
确保 Ergs 网络服务器正在运行,然后测试 MCP 服务器:
# 在一个终端中启动 Ergs 网络服务器
ergs web --port 8080
# 在另一个终端中运行 MCP 服务器
./ergs-mcp
📚 详细文档
配置
MCP 服务器连接到你的 Ergs 网络服务器。默认情况下,它期望 Ergs 在 http://localhost:8080 上运行。
环境变量
ERGS_URL:你的 Ergs 网络服务器的基本 URL(默认:http://localhost:8080)
示例
# 使用默认的 Ergs URL(localhost:8080)
./ergs-mcp
# 连接到自定义的 Ergs 实例
ERGS_URL=http://ergs.example.com:3000 ./ergs-mcp
📄 许可证
本项目采用 MIT 许可证,更多详细信息请参阅 Ergs 项目。
🔗 相关链接
- Ergs - 主要的 Ergs 项目
- MCP Go SDK - 模型上下文协议的 Go SDK
- Model Context Protocol - MCP 规范
微信扫一扫