Runtime environment used to execute the MCP server
Package manager used for installing dependencies and distributing the MCP server
Mliev 短网址 MCP 客户端
基于 MCP(Model Context Protocol)协议的短网址管理客户端,为 AI 助手提供完整的短网址生成、管理和统计功能。
✨ 功能特性
🔗 短网址创建: 支持自定义域名、短代码、标题和描述
📋 批量操作: 一次性创建多个短网址,提高效率
🔍 搜索筛选: 支持域名筛选和关键词搜索
📊 统计分析: 获取详细的点击统计信息
🛡️ 错误处理: 完善的错误处理和重试机制
🔒 安全认证: 基于 Bearer Token 的 API 认证
🚀 快速开始
环境要求
Node.js >= 18.0.0
npm 或 yarn
直接使用MCP
安装依赖
配置环境变量
复制环境变量模板并配置:
编辑 .env
文件:
启动服务
📖 MCP 工具列表
1. create_short_url
创建新的短网址
参数:
original_url
(必填): 原始URL地址domain
(必填): 短网址域名title
(必填): 网页标题custom_code
(可选): 自定义短代码description
(可选): 描述信息expire_at
(可选): 过期时间
示例:
2. get_url_info
获取短网址详细信息
参数:
id
(必填): 短网址ID
示例:
3. list_short_urls
列出短网址,支持分页和搜索
参数:
page
(可选): 页码,默认1page_size
(可选): 每页数量,默认10domain
(可选): 域名筛选keyword
(可选): 搜索关键词
示例:
4. delete_short_url
删除短网址
参数:
id
(必填): 短网址ID
示例:
5. batch_create_short_urls
批量创建短网址
参数:
urls
(必填): URL数组(最多50个)domain
(必填): 短网址域名
示例:
6. list_domains
获取所有可用域名列表
参数: 无需参数
示例:
返回信息:
域名基本信息:ID、域名、协议
网站信息:网站名称、备案信息
配置信息:是否激活、参数透传设置
统计信息:总数、激活数量、未激活数量
🏗️ 项目结构
🔧 开发指南
可用脚本
添加新工具
在
src/mcp/tools/
目录下创建新工具文件实现工具对象,包含
name
、description
、inputSchema
和handler
在
src/mcp/server.js
中注册新工具
错误处理
项目使用统一的错误处理机制:
ErrorHandler.asyncWrapper()
: 包装异步函数,自动处理错误CustomError
: 自定义错误基类ValidationError
: 参数验证错误NetworkError
: 网络请求错误
📝 API 规范
响应格式
所有API响应都遵循统一格式:
错误响应
🔐 配置说明
环境变量
变量名 | 说明 | 默认值 | 必填 |
| 远程服务器地址 | - | ✅ |
| API密钥 | - | ✅ |
| API版本 | v1 | ❌ |
| 请求超时时间(ms) | 10000 | ❌ |
| 最大重试次数 | 3 | ❌ |
| 日志级别 | info | ❌ |
域名配置
确保使用的域名在远程短网址服务中已正确配置。
🚨 故障排除
常见问题
连接失败
检查
REMOTE_BASE_URL
和REMOTE_API_KEY
配置确认网络连接正常
验证远程服务状态
认证失败
确认 API 密钥正确
检查密钥是否有足够权限
参数验证失败
检查参数格式是否正确
确认必填参数都已提供
日志调试
设置日志级别为 debug 查看详细信息:
🤝 贡献指南
Fork 项目
创建特性分支 (
git checkout -b feature/AmazingFeature
)提交更改 (
git commit -m 'Add some AmazingFeature'
)推送到分支 (
git push origin feature/AmazingFeature
)开启 Pull Request
📄 许可证
本项目基于 MIT 许可证开源 - 查看 LICENSE 文件了解详情。
🆘 支持
如果遇到问题或有建议,请:
📊 版本历史
v1.0.0 - 初始版本
基本的短网址管理功能
MCP 协议支持
完整的错误处理机制
remote-capable server
The server can be hosted and run remotely because it primarily relies on remote services or has no dependency on the local environment.
Enables AI assistants to create, manage, and analyze short URLs through complete URL shortening functionality. Supports batch operations, custom domains, click statistics, and comprehensive link management.