Agent Skill
2/7/2026api-lookup
Query API documentation across InspirAI projects. List all projects, view project APIs, or get specific API details.
A
alexxxiong
0GitHub Stars
1Views
npx skills add alexxxiong/claude-skills-inspirai
SKILL.md
| Name | api-lookup |
| Description | Query API documentation across InspirAI projects. List all projects, view project APIs, or get specific API details. |
name: api-lookup description: "Query API documentation across InspirAI projects. List all projects, view project APIs, or get specific API details."
/api-lookup - 查询 API 文档
查询 InspirAI 项目的 API 文档,支持列出所有项目、查看项目 API 列表、查看具体 API 详情。
使用方式
/api-lookup # 列出所有项目
/api-lookup {project} # 显示项目的所有 API
/api-lookup {project} {module} # 显示模块下的 API
/api-lookup {project} {module}/{api} # 显示具体 API 详情
示例
/api-lookup # 列出 inspirai-user 等所有项目
/api-lookup inspirai-user # 显示 inspirai-user 的 20 个 API
/api-lookup inspirai-user auth # 显示 auth 模块的 API
/api-lookup inspirai-user auth/sms-login # 显示 sms-login 的详细文档
执行步骤
Step 1: 定位规范仓库
默认路径:~/.inspirai/apilookup
如果目录不存在,提示用户 clone 仓库:
git clone git@github.com:alexxxiong/inspirai-api-specs.git ~/.inspirai/apilookup
Step 2: 拉取最新
cd {spec_repo}
git pull origin main --quiet
Step 3: 根据参数查询
无参数 - 列出所有项目:
读取 meta.yaml,格式化输出:
InspirAI API Specifications
Projects:
inspirai-user 用户中心服务 - 认证、会员、支付 20 APIs
another-project 其他项目描述 12 APIs
一个参数 - 显示项目 API 列表:
读取 {project}/meta.yaml,格式化输出:
inspirai-user - 用户中心服务
Base URL: https://user-api.inspirai.store
Updated: 2026-01-22
APIs (20):
METHOD ENDPOINT AUTH SUMMARY
POST /api/v1/auth/sms/send - 发送短信验证码
POST /api/v1/auth/sms/login - 短信验证码登录
GET /api/v1/user/profile * 获取用户信息
PUT /api/v1/user/profile * 更新用户信息
...
* = 需要认证
两个参数(模块)- 显示模块 API:
筛选显示指定模块的 API。
完整路径 - 显示 API 详情:
读取 {project}/{module}/{api}.yaml,格式化输出:
POST /api/v1/auth/sms/login
Summary: 短信验证码登录
Auth: 不需要
Description:
使用手机号和短信验证码登录,返回 JWT token
Request (application/json):
phone string required 手机号
code string required 6位短信验证码
Response (200):
token string JWT token,有效期7天
user object 用户基本信息
id number 用户ID
phone string 手机号
nickname string 昵称
member object 会员信息
is_new_user boolean 是否新注册用户
Errors:
400 invalid_code 验证码错误或已过期
400 invalid_phone 手机号格式错误
输出格式
- 简洁的文本格式,便于 AI 快速理解
- 字段对齐,易于阅读
- 只显示必要信息,减少 token 消耗
注意事项
- 每次查询前自动
git pull获取最新文档 - 如果项目或 API 不存在,给出友好提示
- 支持模糊匹配(可选功能)
Skills Info
Original Name:api-lookupAuthor:alexxxiong
Download