使用说明

项目简介

Beyond MCP Server 是一个基于 Model Context Protocol (MCP) 构建的服务器，旨在为大型语言模型 (LLM) 应用提供标准化的社交媒体数据访问能力。它充当 LLM 客户端的后端，提供对 Farcaster 等社交平台数据的便捷访问，并支持通过工具调用执行特定功能。该服务器旨在简化 LLM 应用与社交媒体数据的集成，提供优化的上下文信息，并支持多种传输协议。

主要功能点

MCP 协议兼容: 完全遵循 Model Context Protocol 规范，确保与 MCP 客户端的互操作性。
社交平台数据访问: 支持访问 Farcaster 社交平台的数据，未来计划支持更多平台如 Twitter 和 Telegram。
资源 (Resources) 管理: 提供标准化的资源接口，例如搜索内容、获取用户资料、获取帖子等，方便 LLM 客户端获取结构化数据。
工具 (Tools) 执行: 注册并提供了一系列工具，例如内容搜索、用户信息获取、话题趋势查询等，允许 LLM 客户端调用这些工具来执行特定任务。
Prompt 模板 (Prompts): 预定义了 Prompt 模板，支持针对社交媒体数据进行分析和总结，帮助 LLM 更好地理解和利用上下文信息。
灵活的传输协议: 支持 Stdio 和 HTTP/SSE 两种传输协议，可以根据不同的应用场景选择合适的通信方式。

安装步骤

克隆仓库

git clone https://github.com/Beyond-Network-AI/beyond-mcp-server.git
cd beyond-mcp-server

安装依赖
```
npm install
```
配置环境变量
- 复制 '.env.example' 文件并重命名为 '.env'。
```
cp .env.example .env
```
- 编辑 '.env' 文件，填入 Neynar API 密钥 ('NEYNAR_API_KEY')。您需要访问 Neynar 官网注册并获取 API 密钥才能使用 Farcaster 相关功能。
```
NEYNAR_API_KEY=YOUR_NEYNAR_API_KEY
```
构建项目
```
npm run build
```

服务器配置

MCP 客户端需要配置 MCP 服务器的启动命令和参数才能连接。以下是 Beyond MCP Server 的 Claude Desktop 客户端配置示例 (JSON 格式)，您可以根据您的 MCP 客户端进行相应配置：

{
  "mcpServers": {
    "beyond-social": {
      "command": "/usr/local/bin/node",
      "args": [
        "/full/path/to/beyond-mcp-server/dist/index.js",
        "--stdio"
      ],
      "env": {
        "NEYNAR_API_KEY": "YOUR_API_KEY_HERE",
        "ENABLE_FARCASTER": "true",
        "ENABLE_TWITTER": "false"
      }
    }
  }
}

配置参数说明:

'server name': 'beyond-social' (服务器名称，可以自定义)
'command': '/usr/local/bin/node' (Node.js 运行命令的绝对路径，请根据您的 Node.js 安装路径进行调整)
'args':
- '/full/path/to/beyond-mcp-server/dist/index.js' (服务器入口文件 'index.js' 的绝对路径，请替换为您的项目路径)
- '--stdio' (指定使用 Stdio 传输协议，默认为 Stdio 模式)
'env': (环境变量配置)
- 'NEYNAR_API_KEY': 'YOUR_API_KEY_HERE' (Neynar API 密钥，强烈建议在此处配置，避免密钥泄露风险)
- 'ENABLE_FARCASTER': '"true"' (启用 Farcaster 平台支持)
- 'ENABLE_TWITTER': '"false"' (禁用 Twitter 平台支持，当前 Twitter 功能为占位符)

注意:

请将 '/full/path/to/beyond-mcp-server' 替换为您的 'beyond-mcp-server' 项目的实际绝对路径。
如果您选择 HTTP/SSE 模式，请将 'args' 修改为 '["/full/path/to/beyond-mcp-server/dist/index.js", "--http"]'，并确保您的 MCP 客户端支持 SSE 协议。

基本使用方法

启动服务器

Stdio 模式 (默认):
```
npm start
```
HTTP/SSE 模式:
```
npm run start:http
```

配置 MCP 客户端
- 根据您的 MCP 客户端 (例如 Claude Desktop) 的配置方法，填入上述服务器配置信息。
使用 MCP 客户端发送请求
- MCP 客户端将通过配置的传输协议与 Beyond MCP Server 通信，您可以利用客户端的功能，例如资源浏览、工具调用、Prompt 模板使用等，来获取社交媒体数据或执行相关操作。
- 例如，您可以使用资源 'social://farcaster/AI/search' 在 Farcaster 平台上搜索 "AI" 相关内容。

关键词