README
🚀 limelink-mcp-server
limelink-mcp-server 是一个用于 LimeLink 动态链接管理的 模型上下文协议 (MCP) 服务器。你可以直接从 Claude Code、Claude Desktop 或任何兼容 MCP 的客户端创建、查找和管理动态链接。
开始使用无需 API 密钥! 文档、SDK 设置指南和提示模板无需任何配置即可使用。只需连接并开始与你的 AI 助手一起探索 LimeLink 的功能。
✨ 主要特性
- 文档资源 — 直接从你的 AI 助手访问 LimeLink 文档(15 页 + 索引) — 无需 API 密钥
- 2 个提示模板 — 用于链接创建和 SDK 深度链接设置的引导式工作流程 — 无需 API 密钥
- 3 个工具 — 创建动态链接、按后缀查找、按 URL 查找(需要 API 密钥)
- 内存缓存 — 文档获取的 1 小时 TTL 缓存
无需 API 密钥即可使用的功能
| 功能 | 类别 | API 密钥 | 描述 |
|---------|----------|:-------:|-------------|
| limelink://docs/index | 资源 | 不需要 | 完整文档索引 |
| limelink://docs/{slug} | 资源 | 不需要 | 15 个单独的文档页面 |
| setup-deep-linking | 提示 | 不需要 | iOS/Android SDK 设置指南 |
| create-dynamic-link | 提示 | 不需要 | 链接创建指南(使用 create-link 工具执行) |
| create-link | 工具 | 必需 | 通过 API 创建动态链接 |
| get-link-by-suffix | 工具 | 必需 | 按后缀查找链接 |
| get-link-by-url | 工具 | 必需 | 按 URL 查找链接 |
🚀 快速开始
无需 API 密钥(文档和指南)
无需 API 密钥。连接后即可立即开始探索 LimeLink 文档和设置指南:
{
"mcpServers": {
"limelink": {
"command": "npx",
"args": ["-y", "limelink-mcp-server"]
}
}
}
你可以尝试向你的 AI 助手提问:
- "阅读 LimeLink 入门文档"
- "如何为 iOS 设置深度链接?"
- "展示 LimeLink SDK 集成指南"
使用 API 密钥(完整功能)
添加你的 API 密钥以解锁链接创建和管理工具:
{
"mcpServers": {
"limelink": {
"command": "npx",
"args": ["-y", "limelink-mcp-server"],
"env": {
"LIMELINK_API_KEY": "your_api_key_here"
}
}
}
}
全局安装使用
npm install -g limelink-mcp-server
{
"mcpServers": {
"limelink": {
"command": "limelink-mcp-server",
"env": {
"LIMELINK_API_KEY": "your_api_key_here"
}
}
}
}
📦 安装指南
Claude Code
添加 MCP 服务器最简单的方法是使用 claude mcp add 命令:
# 无需 API 密钥(仅文档和指南)
claude mcp add --scope user --transport stdio limelink -- npx -y limelink-mcp-server
# 使用 API 密钥(完整功能)
claude mcp add --scope user --transport stdio limelink \
--env LIMELINK_API_KEY=your_api_key_here \
-- npx -y limelink-mcp-server
作用域选项:
--scope user— 在所有项目中可用--scope project— 保存到.mcp.json(可通过 Git 与团队共享)
Claude Desktop 及其他 MCP 客户端
将 JSON 配置添加到客户端的配置文件中:
| 客户端 | 配置文件 |
|--------|-------------|
| Claude Desktop (macOS) | ~/Library/Application Support/Claude/claude_desktop_config.json |
| Claude Desktop (Windows) | %APPDATA%\Claude\claude_desktop_config.json |
环境变量
| 变量 | 是否必需 | 默认值 | 描述 |
|----------|----------|---------|-------------|
| LIMELINK_API_KEY | 否 | — | 用于链接管理工具的 API 密钥。文档资源和提示模板无需此密钥即可使用。 |
| LIMELINK_PROJECT_ID | 否 | — | 默认项目 ID(在工具调用中未指定时使用) |
你可以从 LimeLink 仪表盘 获取 API 密钥。无需 API 密钥,文档资源、SDK 设置指南和提示模板均可完全使用。
💻 使用示例
工具使用示例
create-link
创建带有特定平台深度链接、社交预览和 UTM 跟踪的动态链接。
参数:
| 参数 | 类型 | 是否必需 | 描述 |
|-----------|------|----------|-------------|
| dynamic_link_suffix | 字符串 | 是 | 短 URL 路径标识符(最多 50 个字符) |
| dynamic_link_url | 字符串 | 是 | 目标 URL(最多 500 个字符) |
| dynamic_link_name | 字符串 | 是 | 链接名称(最多 100 个字符) |
| project_id | 字符串 | 否 | 项目 ID(默认使用环境变量) |
| stats_flag | 布尔值 | 否 | 启用分析跟踪 |
| apple_options | 对象 | 否 | iOS 深度链接选项 |
| android_options | 对象 | 否 | Android 深度链接选项 |
| additional_options | 对象 | 否 | 社交预览 + UTM 选项 |
在 Claude 中的使用示例:
"为 https://example.com/product/123 创建一个后缀为 'product-123' 的动态链接,并启用分析"
get-link-by-suffix
按后缀查找动态链接。
| 参数 | 类型 | 是否必需 | 描述 |
|-----------|------|----------|-------------|
| suffix | 字符串 | 是 | 动态链接后缀 |
| project_id | 字符串 | 否 | 项目 ID(默认使用环境变量) |
get-link-by-url
按完整 URL 查找动态链接。可自动从以下两种 URL 格式中提取后缀:
- 免费计划:
https://deep.limelink.org/{suffix} - 专业计划:
https://{project}.limelink.org/link/{suffix}
| 参数 | 类型 | 是否必需 | 描述 |
|-----------|------|----------|-------------|
| url | 字符串 | 是 | 完整的 LimeLink 动态链接 URL |
| project_id | 字符串 | 否 | 项目 ID(默认使用环境变量) |
资源使用示例
limelink://docs/index
返回完整的 LimeLink 文档索引 (llms.txt)。
limelink://docs/{slug}
返回单个文档页面。可用的 slug 有:
introduction, getting-started, project, application, dynamic-link, create-link, link-detail, link-management, appearance, sdk-integration, ios-sdk, android-sdk, api-integration, advanced, llm-agent
在 Claude 中的使用示例:
"阅读 LimeLink API 集成文档"
Claude 将访问
limelink://docs/api-integration
提示模板使用示例
create-dynamic-link
创建动态链接的引导式工作流程。
| 参数 | 类型 | 是否必需 | 描述 |
|----------|------|----------|-------------|
| target_url | 字符串 | 是 | 目标 URL |
| suffix | 字符串 | 否 | 自定义后缀 |
| platforms | 枚举 | 是 | ios, android, both, 或 web |
setup-deep-linking
设置 LimeLink SDK 深度链接的引导式工作流程。
| 参数 | 类型 | 是否必需 | 描述 |
|----------|------|----------|-------------|
| platform | 枚举 | 是 | ios, android, 或 both |
📚 详细文档
开发
前提条件
- Node.js >= 18
- pnpm
设置
git clone https://github.com/hellovelop/limelink-mcp-server.git
cd limelink-mcp-server
pnpm install
pnpm run build
本地运行
LIMELINK_API_KEY=your_key node dist/index.js
测试
pnpm test # 单元测试
pnpm test:e2e # 端到端测试(MCP 标准输入输出通信)
pnpm test:watch # 监视模式下的单元测试
pnpm test:coverage # 覆盖率报告
项目结构
src/
├── index.ts # 入口点
├── lib/
│ ├── config.ts # 环境变量加载
│ ├── cache.ts # 内存 TTL 缓存
│ ├── api-client.ts # LimeLink API HTTP 客户端
│ └── doc-fetcher.ts # 带缓存的文档获取器
├── tools/
│ ├── create-link.ts # create-link 工具
│ ├── get-link-by-suffix.ts
│ └── get-link-by-url.ts
├── resources/
│ └── documentation.ts # 文档资源
└── prompts/
├── create-link-prompt.ts
└── deep-link-prompt.ts
📄 许可证
MIT
微信扫一扫