Agent Skill 接入指南
在 Cursor、Claude Code 或 Codex 中安装本站 Skill 后,可按官方文档生成接入代码。Path、字段、签名以本站为准,不要凭印象填写。
安装包是本站提供的 zip,放到你们自己的业务工程即可,不用拉 OpenDoc 源码。
能力范围
覆盖酒店、旅游线路、支付(收银台)、H5。机票暂不对分销商开放。
Skill 只帮你写客户端代码,不会替你调生产接口。鉴权格式见 接口公共协议,文档里没有的字段不要写进请求。
安装前准备
- 已开通分销账号,拿到
x-lvcang-api-account和aesKey - 本机已装 Node.js
- 已装 Cursor、Claude Code 或 Codex 之一
安装
在业务工程根目录执行。Windows 请带上 --copy。装好后,对应目录下会出现 SKILL.md。
接口文档更新后一般不用重装。鉴权方式或签名脚本变了,再跑一次下面的命令即可。
Cursor
文件位置:.cursor/skills/lvcang-opendoc/SKILL.md
bash
npx skills add https://open.lvcang.cn/doc/skill/lvcang-opendoc.zip --skill lvcang-opendoc -a cursor --copy -y多个项目共用可加 -g,装到 ~/.cursor/skills/(Windows 为 %USERPROFILE%\.cursor\skills\)
Claude Code
文件位置:.claude/skills/lvcang-opendoc/SKILL.md
bash
npx skills add https://open.lvcang.cn/doc/skill/lvcang-opendoc.zip --skill lvcang-opendoc -a claude-code --copy -y加 -g 则装到 ~/.claude/skills/。
Codex
文件位置:.agents/skills/lvcang-opendoc/SKILL.md(部分环境是 .codex/skills/)
bash
npx skills add https://open.lvcang.cn/doc/skill/lvcang-opendoc.zip --skill lvcang-opendoc -a codex --copy -y加 -g 则装到 ~/.codex/skills/。
不用 npx 时(手动安装)
下载 lvcang-opendoc.zip,解压后把 skills/lvcang-opendoc/ 拷到上面列出的目录。也可以在解压后的目录执行:
bash
npx skills add ./解压目录 --skill lvcang-opendoc -a cursor --copy -y账号和密钥
账号和 aesKey 放本机环境变量或 IDE secrets。不要写进代码、Skill 文件或 git,也不要贴到和 Agent 的对话里。生成代码里只写变量名。
不小心贴过密钥的,到开放平台轮换 aesKey,并检查本地仓库和 git 历史。
| 变量 | 说明 |
|---|---|
LVCANG_API_ACCOUNT | 请求头 x-lvcang-api-account |
LVCANG_AES_KEY | AES 签名用,脚本读取,不要打印 |
LVCANG_API_BASE | 接口根地址,默认 https://openapi.lvcang.cn |
OPENDOC_ORIGIN | 文档站根地址,不含 /doc。默认 https://open.lvcang.cn。联调预发时改成预发根地址 |
macOS / Linux:
bash
export LVCANG_API_ACCOUNT="<开放平台分配的账号>"
export LVCANG_AES_KEY="<开放平台分配的 aesKey>"
export LVCANG_API_BASE="https://openapi.lvcang.cn"Windows PowerShell(仅当前窗口有效,长期请配系统环境变量或 IDE secrets):
powershell
$env:LVCANG_API_ACCOUNT="<开放平台分配的账号>"
$env:LVCANG_AES_KEY="<开放平台分配的 aesKey>"
$env:LVCANG_API_BASE="https://openapi.lvcang.cn"怎么对 Agent 说
新开一轮对话,把目标和环境说清楚,例如:
text
使用 lvcang-opendoc skill,按官方 OpenDoc 生成 Java 酒店列表接入代码。
账号和 aesKey 已在环境变量里。先读官方文档再写代码,不要编造字段。不要把密钥写进对话,例如「aesKey 是 xxx」。
建议在业务仓库加 AGENTS.md 或 CLAUDE.md:
markdown
接入同程旅仓 OpenAPI 时,使用已安装的 lvcang-opendoc skill。
先读官方 llms.txt 再写代码。密钥只放环境变量,不要写入对话或仓库。如果 Agent 没打开本站文档就开始填 Path,停下来让它按 Skill 重做。
相关文档
- Agent 用的目录:/llms.txt(预发站用预发域名)
- 协议:接口公共协议
- 联调:签名验证工具、API 接口测试工具
