Limelink Mcp Server

@limelink/mcp

한국어 · 文档 · 功能参考

一个用于 LimeLink 动态链接管理的 Model Context Protocol (MCP) 服务。可直接通过 Claude Code、Claude Desktop 或任何兼容 MCP 的客户端创建、查找和管理动态链接。

开始使用无需 API 密钥！ 文档和 SDK 设置指南无需任何配置即可使用。只需连接，即可开始通过 AI 助手探索 LimeLink 功能。

功能

• 文档资源 — 直接通过 AI 助手访问 LimeLink 文档（15 个页面 + 索引）——无需 API 密钥
• 5 个工具 — 发现配置文件和 Projects、创建动态链接以及查找链接（API 工具需要配置文件）
• 内存缓存 — 文档获取缓存的 TTL 为 1 小时

运行环境

• Node.js 18 或更高版本
• 仅支持 stdio 传输；不支持 Remote MCP/HTTP 传输
• npm 包：@limelink/mcp；全局可执行文件：limelink-mcp
• stdout 专用于 MCP 协议；诊断信息和封装器日志必须写入 stderr

完整的运行约定请参阅安装与配置和网络行为。

哪些功能无需 API 密钥即可使用？

功能	类别	API 密钥	说明
limelink://docs/index	资源	不需要	完整文档索引
limelink://docs/{slug}	资源	不需要	15 个独立文档页面
list-profiles	工具	不需要	列出本地配置的配置文件别名，不会联系 API
list-projects	工具	必需	列出所选 Organization 配置文件中的 Projects
list-custom-domains	工具	必需	列出所选 Project 的 Custom Domains
create-link	工具	必需	通过 API 创建 V2 Core Links
get-link-by-suffix	工具	必需	按后缀查找链接
get-link-by-url	工具	必需	按 URL 查找链接

快速开始

无需 API 密钥（文档与指南）

无需 API 密钥。连接后即可立即开始探索 LimeLink 文档和设置指南：

{
  "mcpServers": {
    "limelink": {
      "command": "npx",
      "args": ["-y", "@limelink/mcp"]
    }
  }
}

试着向 AI 助手提问：

• “阅读 LimeLink 入门文档”
• “如何为 iOS 设置深度链接？”
• “给我看看 LimeLink SDK 集成指南”

使用 Organization 配置文件（完整功能）

创建下方所示的 version 1 配置文件，并传入其绝对路径：

{
  "mcpServers": {
    "limelink": {
      "command": "npx",
      "args": ["-y", "@limelink/mcp"],
      "env": {
        "LIMELINK_PROFILES_FILE": "/absolute/path/to/limelink-profiles.json"
      }
    }
  }
}

全局安装后的用法

npm install -g @limelink/mcp

{
  "mcpServers": {
    "limelink": {
      "command": "limelink-mcp",
      "env": {
        "LIMELINK_PROFILES_FILE": "/absolute/path/to/limelink-profiles.json"
      }
    }
  }
}

配置

Claude Code

添加 MCP 服务最简单的方法是使用 claude mcp add 命令：

# Without API key (docs & guides only)
claude mcp add --scope user --transport stdio limelink -- npx -y @limelink/mcp

# With API key (full features)
claude mcp add --scope user --transport stdio limelink \
  --env LIMELINK_PROFILES_FILE=/absolute/path/to/limelink-profiles.json \
  -- npx -y @limelink/mcp

作用域选项：

• --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

配置文件

{"version":1,"defaultProfile":"work","profiles":{"work":{"apiKey":"your_api_key","organizationLabel":"Work","projects":{"marketing":"11111111-1111-4111-8111-111111111111"}}}}

环境变量

变量	必填	默认值	描述
LIMELINK_PROFILES_FILE	否	—	包含命名组织凭据配置的版本 1 JSON 文件路径。

LIMELINK_API_KEY 和 LIMELINK_PROJECT_ID 将被忽略。如果未配置凭据配置，依赖 API 的工具会引导 Agent 前往 Organizations 创建组织 API 密钥并配置配置文件。依赖 Project 的工具可直接接受 Project UUID。配置文件中的可选 projects 映射是方便重复使用的推荐设置，并非必需；如果有用，可在通过 list-projects 发现 Project 后添加别名。配置文件会在首次调用依赖 API 的工具时，通过凭据检查进行延迟初始化。修改配置文件（包括添加别名）后，必须重启 MCP 服务。

你可以从 LimeLink Dashboard 获取 API 密钥。没有 API 密钥也可以完整使用文档资源和 SDK 设置指南。

工具

list-profiles

列出已配置的别名、组织标签、默认状态和当前初始化状态，不会联系 API。已初始化的配置文件会显示作用域。API 密钥值会保密，绝不会返回。组织、Project、自定义域名和凭据标识符以及密钥前缀均为非机密标识符，在有用时可能会出现在依赖 API 的工具响应中。

list-projects

列出通过所选配置文件的凭据发现的组织中的 Project。可选参数 profile；凭据需要 projects:read 权限。

list-custom-domains

列出必填参数 project（别名或 UUID）对应的自定义域名。可选参数 profile；凭据需要 domains:read 权限。

create-link

创建 V2 Core Link，支持特定平台的深度链接、自定义域名选择、社交预览和 UTM 跟踪。

参数：

参数	类型	必填	描述
dynamic_link_suffix	string	否	短网址路径标识符（1–100）；省略时由 API 生成
dynamic_link_url	string	是	目标 URL（最多 500 个字符）
dynamic_link_name	string	是	链接名称（最多 100 个字符）
project	string	是	所选配置文件中的 Project 别名或 Project UUID
profile	string	否	配置文件别名；否则使用已配置的默认配置文件或唯一配置文件
custom_domain_id	UUID string	否	Core Link 使用的自定义域名
stats_flag	boolean	否	启用分析跟踪
apple_options	object	否	iOS 深度链接选项
android_options	object	否	Android 深度链接选项
additional_options	object	否	社交预览和 UTM 选项

在 Claude 中的示例用法：

“为 https://example.com/product/123 创建动态链接，后缀为 ‘product-123’，并启用分析”

get-link-by-suffix

通过后缀查找动态链接。

参数	类型	必填	描述
suffix	string	是	动态链接后缀
project	string	是	所选配置文件中的 Project 别名或 Project UUID
profile	string	否	配置文件别名；否则使用已配置的默认配置文件或唯一配置文件

get-link-by-url

通过完整 URL 使用 V2 API 解析链接。后端会判断该 URL 属于 Free 默认命名空间、Project 主机名还是启用的自定义域名。无需选择 Project，也无需在本地解析后缀。

URL 必须是绝对 HTTPS URL，且路径中只能有一个 /{suffix} 段；不得包含查询参数、片段、显式端口或凭据。

参数	类型	必填	描述
url	string	是	要解析的完整 LimeLink URL（最多 2048 个字符）
profile	string	否	配置文件别名；否则使用已配置的默认配置文件或唯一配置文件

资源

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

开发

前置条件

• Node.js >= 18
• pnpm

设置

git clone https://github.com/hellovelop/limelink-mcp-server.git
cd limelink-mcp-server
pnpm install
pnpm run build

本地运行

LIMELINK_PROFILES_FILE=/absolute/path/to/limelink-profiles.json node dist/index.js

测试

pnpm test          # Unit tests
pnpm test:e2e      # E2E tests (MCP stdio communication)
pnpm test:watch    # Unit tests in watch mode
pnpm test:coverage # Coverage report

项目结构

src/
├── index.ts              # Entry point
├── lib/
│   ├── config.ts         # Environment variable loading
│   ├── cache.ts          # In-memory TTL cache
│   ├── api-client.ts     # LimeLink API HTTP client
│   └── doc-fetcher.ts    # Documentation fetcher with caching
├── tools/
│   ├── create-link.ts    # create-link tool
│   ├── get-link-by-suffix.ts
│   └── get-link-by-url.ts
└── resources/
    └── documentation.ts  # Documentation resources

许可证

MIT