@limelink/mcp

한국어 · 文档 · 功能参考

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

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

功能

• 文档资源 — 直接从您的 AI 助手访问 LimeLink 文档（15 个页面 + 索引）——无需 API 密钥

• 5 个工具 — 发现配置文件和 Projects、创建动态链接以及查询链接（API 工具需要已配置的配置文件）

• 内存缓存 — 文档抓取使用 1 小时 TTL 缓存

运行时

• Node.js 18 或更高版本

• 仅支持 stdio 传输；不支持远程 MCP/HTTP 传输

• npm 包：@limelink/mcp；全局可执行文件：limelink-mcp

• stdout 保留用于 MCP 协议；诊断和包装器日志必须使用 stderr

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

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

Related MCP server: lynxprompt-mcp

快速开始

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

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

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

尝试向您的 AI 助手提问：

• “阅读 LimeLink 入门文档”

• “如何为 iOS 设置深度链接？”

• “查看 LimeLink SDK 集成指南”

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

创建下面所示的版本 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 配置添加到您客户端的配置文件中：

配置文件

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

环境变量

LIMELINK_API_KEY 和 LIMELINK_PROJECT_ID 会被忽略。当没有配置凭据配置文件时，基于 API 的工具会引导代理前往 Organizations 签发 Organization API 密钥并配置配置文件。基于 Project 的工具直接接受 Project UUID。配置文件中可选的 projects 映射是为反复使用的 Projects 提供的便捷方式，并非必需条件；如果有用，可在 list-projects 发现之后添加别名。配置文件会在首次 API 调用时通过凭据内省进行惰性初始化。配置文件变更（包括添加别名）需要重启 MCP 服务器。

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

工具

list-profiles

列出已配置的别名、Organization 标签、默认状态以及当前初始化状态，无需联系 API。已初始化的配置文件包含作用域。API 密钥值保持机密，绝不会返回。Organization、Project、Custom Domain 和凭据标识符及密钥前缀是非机密标识符，在有用时可能出现在基于 API 的工具响应中。

list-projects

列出从所选配置文件的凭据中发现的 Organization 中的 Projects。接受可选的 profile 参数；凭据需要 projects:read 权限。

list-custom-domains

列出所需 project（别名或 UUID）的 Custom Domains。接受可选的 profile 参数；凭据需要 domains:read 权限。

create-link

创建带有平台专属深度链接、Custom Domain 选择、社交预览和 UTM 跟踪的 V2 Core Link。

参数：

在 Claude 中的示例用法：

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

get-link-by-suffix

按后缀查询动态链接。

get-link-by-url

使用完整 URL 通过 V2 API 解析链接。后端会判断该 URL 属于 Free 默认命名空间、Project 主机名还是活动 Custom Domain。无需 Project 选择器或本地后缀解析。

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

资源

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