|
1 | | -# ALAPI MCP Server |
| 1 | +# 🔥 ALAPI MCP Server |
2 | 2 |
|
3 | 3 | [](https://smithery.ai/server/@ALAPI-SDK/mcp-alapi-cn) |
| 4 | + |
4 | 5 |
|
5 | | -这是一个基于 [ALAPI](https://www.alapi.cn) 的 MCP (Model Control Protocol) 服务器实现,可以通过MCP协议直接调用ALAPI的接口 |
| 6 | +这是一个基于 [ALAPI](https://www.alapi.cn) 的 MCP (Model Context Protocol) 服务器实现,可以通过MCP协议直接调用ALAPI的接口,轻松将ALAPI丰富的API资源集成到各类支持MCP的AI应用中。 |
6 | 7 |
|
7 | | -## 功能特点 |
| 8 | +## ✨ 功能特点 |
8 | 9 |
|
9 | | -- 自动加载 ALAPI OpenAPI 规范 |
10 | | -- 支持加载全部或指定 API (短视频解析、天气查询、每天60秒读懂世界、企业查询...) |
11 | | -- 符合 MCP 协议标准 |
12 | | -- 统一的错误处理和响应格式 |
13 | | -- 支持环境变量配置 |
| 10 | +- 🔍 **丰富API资源** - 提供IP查询、天气查询、热搜榜单、企业信息等100+种常用API服务 |
| 11 | +- 🧩 **MCP 协议支持** - 完全兼容 Model Context Protocol,轻松集成到各类AI应用 |
| 12 | +- 🔄 **自动加载** - 自动加载 ALAPI OpenAPI 规范,无需手动配置 |
| 13 | +- 🎯 **灵活调用** - 支持加载全部或指定API,按需使用(短视频解析、天气查询、每天60秒读懂世界、企业查询等) |
| 14 | +- 🛡️ **统一响应** - 提供统一的错误处理和响应格式,简化开发流程 |
| 15 | +- ⚙️ **可配置性** - 支持环境变量配置,轻松适应不同使用场景 |
14 | 16 |
|
15 | | -## 环境要求 |
| 17 | +## 📖 使用指南 |
16 | 18 |
|
17 | | -- Go 1.24.1 或更高版本 |
18 | | -- 有效的 ALAPI Token |
19 | | -- 支持 MCP 的客户端(如 Claude Desktop、Continue、Cursor 等) |
| 19 | +首先需要了解 [MCP](https://modelcontextprotocol.io/introduction) 协议,然后按照以下配置添加 ALAPI MCP 服务。 |
20 | 20 |
|
21 | | -## 安装 |
| 21 | +## 在 MCP 客户端中使用 |
22 | 22 |
|
23 | | -### Installing via Smithery |
| 23 | +ALAPI MCP Server 设计为与支持 MCP 协议的客户端配合使用,不支持独立的命令行配置。请按照以下步骤在您的 MCP 客户端中配置使用: |
24 | 24 |
|
25 | | -To install mcp-alapi-cn for Claude Desktop automatically via [Smithery](https://smithery.ai/server/@ALAPI-SDK/mcp-alapi-cn): |
| 25 | +### 方法一:使用 Smithery 自动安装 |
26 | 26 |
|
27 | | -```bash |
28 | | -npx -y @smithery/cli install @ALAPI-SDK/mcp-alapi-cn --client claude |
29 | | -``` |
| 27 | +通过 [Smithery](https://smithery.ai/server/@ALAPI-SDK/mcp-alapi-cn) 安装 ALAPI MCP Server,适用于 Claude Desktop 客户端: |
30 | 28 |
|
31 | | -### 构建安装 |
32 | 29 | ```bash |
33 | | -#Github |
34 | | -git clone https://github.com/alapi-sdk/mcp-alapi-cn.git |
35 | | - |
36 | | -#CNB 国内加速地址 |
37 | | -#git clone https://cnb.cool/alapi/mcp-alapi-cn.git |
38 | | - |
39 | | -cd mcp-server |
40 | | -go mod tidy |
41 | | -go build |
| 30 | +npx -y @smithery/cli install @ALAPI-SDK/mcp-alapi-cn --client claude |
42 | 31 | ``` |
43 | 32 |
|
44 | | -### 下载已构建的软件包 |
45 | | -下载对应系统的软件包 |
| 33 | +### 方法二:直接使用预编译二进制文件(推荐,不用安装依赖) |
46 | 34 |
|
47 | | -Github: https://github.com/ALAPI-SDK/mcp-alapi-cn/releases |
| 35 | +1. 访问 [Releases 页面](https://github.com/ALAPI-SDK/mcp-alapi-cn/releases) 下载最新版本 |
| 36 | + > 国内加速下载地址:https://cnb.cool/alapi/mcp-alapi-cn/-/releases |
48 | 37 |
|
49 | | -CNB(国内加速): https://cnb.cool/alapi/mcp-alapi-cn/-/releases |
| 38 | +2. 根据您的操作系统选择对应最新的版本: |
| 39 | + - Windows: `mcp-alapi-cn.exe` |
| 40 | + - macOS: `mcp-alapi-cn-macos` |
| 41 | + - Linux: `mcp-alapi-cn-linux` |
50 | 42 |
|
51 | | -## 配置和使用 |
| 43 | +3. 在支持 MCP 的客户端(如 Claude Desktop)中配置: |
| 44 | + - 打开 MCP 客户端设置 |
| 45 | + - 添加新的 MCP 服务器 |
| 46 | + - 指定下载的二进制文件路径 |
| 47 | + - 配置必要的环境变量(如 `ALAPI_TOKEN`) |
52 | 48 |
|
53 | | -### 环境变量配置 |
| 49 | +### 配置环境变量 |
54 | 50 |
|
55 | | -项目使用以下环境变量: |
| 51 | +#### `ALAPI_TOKEN` - ALAPI平台访问令牌(必填) |
56 | 52 |
|
57 | | -- `ALAPI_TOKEN`(必需):ALAPI 的认证令牌,在 [token管理](https://www.alapi.cn/dashboard/data/token) 里面创建, **如果不设置,mcp 会启动不了** |
58 | | -- `ALAPI_ID`(可选):指定要加载的 API ID,不设置则加载所有 API(实际的API_id 可通过 [ALAPI](https://www.alapi.cn) 官网查看,可在我的API里面查询) |
| 53 | +需要配置为您在 ALAPI 平台上创建的 [TOKEN](https://www.alapi.cn/dashboard/data/token),用于接口认证。 |
59 | 54 |
|
| 55 | +### MCP 客户端配置示例 |
60 | 56 |
|
61 | | -### Cursor配置方式 |
| 57 | +在 Claude Desktop 或其他支持 MCP 的客户端中,可以参考以下配置: |
62 | 58 |
|
63 | | -1. 打开Cursor设置 > 扩展 > MCP工具 |
64 | | -2. 添加新的MCP工具 |
65 | | -3. 按照以下格式填写配置: |
| 59 | +#### JSON 配置(使用本地二进制文件) |
66 | 60 |
|
67 | 61 | ```json |
68 | 62 | { |
69 | | - "mcpServers": { |
70 | | - "mcp-alapi-cn": { |
71 | | - "command": "C:\\Users\\Administrator\\实际目录\\mcp-alapi-cn.exe", |
72 | | - "env": { |
73 | | - "ALAPI_TOKEN": "xxxx", |
74 | | - "ALAPI_API_ID": "0" |
75 | | - } |
76 | | - } |
| 63 | + "mcpServers": { |
| 64 | + "alapi": { |
| 65 | + "path": "/path/to/mcp-alapi-cn", |
| 66 | + "env": { |
| 67 | + "ALAPI_TOKEN": "在 ALAPI 平台申请创建的 token" |
| 68 | + } |
77 | 69 | } |
| 70 | + } |
78 | 71 | } |
79 | 72 | ``` |
80 | 73 |
|
81 | | -### CherryStudio配置方式 |
82 | | -1. 打开 CherryStudio 设置 -> MCP 服务器 |
83 | | -2. 添加MCP服务器 |
84 | | -3. 配置说明: |
85 | 74 |
|
86 | | -名称: `MCP-ALAPI-CN` |
87 | | -类型: `STDIO` |
88 | | -命令: `C:\\Users\\Administrator\\实际目录\\mcp-alapi-cn.exe` |
89 | | -环境变量: |
90 | | -``` |
91 | | -ALAPI_TOKEN=你的token |
92 | | -``` |
| 75 | +### 支持的 MCP 客户端 |
| 76 | + |
| 77 | +根据 [MCP 文档](https://modelcontextprotocol.io/clients),以下客户端支持 MCP 工具集成: |
| 78 | + |
| 79 | +- Claude Desktop App |
| 80 | +- Claude Code |
| 81 | +- Cursor |
| 82 | +- Continue |
| 83 | +- Cline |
| 84 | +- 等其他支持 MCP 协议的客户端 |
| 85 | + |
| 86 | +> 注意:确保您的 MCP 客户端支持工具集成功能,请参考各客户端的具体文档进行配置。 |
| 87 | +
|
| 88 | +## 🛠️ 支持的功能 |
| 89 | + |
| 90 | +以下是部分支持的功能,完整功能请以实际调用为准: |
| 91 | + |
| 92 | +| 功能名称 | 描述 | |
| 93 | +| ------------ | ----------------------------------------------------------------------------- | |
| 94 | +| IP查询 | 查询IP归属地信息,支持IPv4和IPv6 | |
| 95 | +| 天气查询 | 查询国内天气详情,包含天气信息、天气预警、天气指数、AQI等 | |
| 96 | +| 今日热榜 | 查询今日热榜数据,包含抖音热搜、头条热榜、知乎、36k、百度热搜、微博热搜等数据 | |
| 97 | +| 文本审核 | 查询文本是否违规,特别适合AI内容审核 | |
| 98 | +| 短网址 | 短网址缩短,将长网址缩短为短网址,方便短信发送、二维码生成等场景 | |
| 99 | +| 二维码识别 | 支持一图多码,支持数十二维码,条形码的识别 | |
| 100 | +| 历史上的今天 | 查询历史上的指定日期发生的大事 | |
| 101 | +| 汇率查询 | 根据货币代码查询货币汇率和换算,支持全球170+个国家和地区货币查询 | |
| 102 | +| 企业查询 | 根据企业名称或统一社会信用代码查询企业基本工商信息 | |
| 103 | +| 快递查询 | 免费查询快递物流轨迹,支持中通、申通、顺丰、极兔、百世、圆通等 | |
| 104 | +| 星座运势 | 提供星座运势查询服务,支持查询十二星座今日或明日、本周、本月、本年的运势 | |
| 105 | +| 黄金价格 | 查询当前黄金的实时价格,最高价,最低价,品牌黄金的价格 | |
| 106 | + |
| 107 | +## 🔗 相关链接 |
| 108 | + |
| 109 | +- [ALAPI官网](https://www.alapi.cn) - 获取API服务和Token |
| 110 | +- [MCP协议文档](https://modelcontextprotocol.io) - 了解更多MCP协议相关信息 |
| 111 | + |
| 112 | +## 🙏 鸣谢 |
| 113 | + |
| 114 | +- [ALAPI](https://www.alapi.cn) - 提供强大的API支持 |
| 115 | +- [Model Context Protocol](https://modelcontextprotocol.io) - 提供协议标准 |
| 116 | + |
| 117 | + |
0 commit comments