使用说明(Markdown格式)
-
项目简介
- Ayrshare MCP Server 是一个基于 FastMCP 的后端服务器,向 MCP 客户端以标准化的 JSON-RPC 方式提供资源访问、工具执行与 Prompt 渲染等能力,供大语言模型(LLM)客户端在生成、调度与分析社媒内容时获取上下文、执行外部功能、渲染模板等服务。
-
主要功能点
- MCP 核心功能
- 资源(Resources):通过 ayrshare:// 开头的 URI 提供对历史、日历、分析、平台等动态数据的只读访问,用于数据驱动的对话与推理。
- 工具(Tools):注册大量的发布、分析、媒体管理、广告、 webhook、平台集成等工具,LLM 客户端可调用以触发实际操作或查询信息。
- Prompts:提供用于生成社媒内容、分析与调度的模板 prompt,确保与平台特性的一致性与可控性。
- 多传输与会话
- 服务器通过 JSON-RPC 与客户端通信,具备 STDIO、HTTP 等传输方式的支持(在配置中可指定传输方式)。
- 安全与扩展
- 集成 Ayrshare API 调用、会话管理与错误处理,具备可扩展的能力声明与资源渲染能力。
- 资源示例
- ayrshare://history、ayrshare://platforms、ayrshare://analytics/dashboard/{period}、ayrshare://calendar/{year}/{month}、ayrshare://profiles/overview 等,用于查询历史、已连接平台、分析看板、日历与客户档案等。
- MCP 核心功能
-
安装步骤
- 克隆或获取项目代码到本地
- 创建并启用虚拟环境
- 安装依赖并将项目作为包安装
- 复制环境变量模板并填入实际凭据,例如 Ayrshare 的 API Key
- 启动 MCP 服务器,选择 STDIO(用于 Claude Desktop 等 MCP 客户端)或 HTTP(远程访问)
- 使用 MCP 客户端连接服务器,测试资源、工具、Prompts 的调用与返回
-
服务器配置(MCP 客户端需要的连接信息,JSON 格式,包含 server name、command、args 等) 说明:以下为配置示例描述,实际值请据实填入。该配置用于 MCP 客户端在本地启动并连接 MCP 服务器,不作为代码块展示,仅用于说明。
{ "server_name": "ayrshare", "command": "python", "args": ["/abs/path/to/ayrshare-mcp/src/server.py"], "env": { "AYRSHARE_API_KEY": "your_actual_api_key_here", "AYRSHARE_PROFILE_KEY": "optional-profile-key" } // 说明: // - server_name 为 MCP 客户端显示的服务器名称,可自行命名 // - command 与 args 指定启动服务器的命令与参数,此处为用 Python 直接运行服务器脚本 // - env 提供所需的环境变量,如 Ayrshare 的 API Key,若多租户可设置 Profile Key }
-
基本使用方法
- 本地运行
- 在含有 server.py 的项目根目录执行:fastmcp run src/server.py
- 或直接运行:python src/server.py
- 远程 HTTP 访问
- 运行时携带 --http 参数,服务器将提供 HTTP API,便于远程调用
- 测试与开发
- 使用 FastMCP 提供的开发模式进行交互测试,并通过 mcp.dev 等工具执行工具、查询资源
- 常见操作示例
- 调用 post_to_social 工具在一个或多个平台发布即时内容
- 调用 get_post_analytics 获取指定帖子的分析数据
- 使用 ayrshare://history 等资源获取最近的历史数据用于分析/呈现
- 本地运行
信息
分类
网页与API