内容
# 工具列表
## 简介
Shopby 官方文档没有搜索功能，每次都需要手动查找 API 接口。为了解决这个问题，我们开发了一个工具，可以索引 Shopby 的 OpenAPI（YAML）规格，并通过自然语言查询来找到相应的 API 接口。
## 功能特点
* **索引 Shopby OpenAPI（YAML）规格**：该工具可以索引 Shopby 的 OpenAPI（YAML）规格，并将其转化为可搜索的格式。
* **自然语言查询**：用户可以通过自然语言查询来找到相应的 API 接口。
* **支持多种查询方式**：支持多种查询方式，包括搜索、浏览和详细查询。
* **自动更新索引**：该工具可以自动更新索引，以确保用户始终可以访问最新的 API 接口。
## 安装和使用
### 安装
```bash
claude mcp add shopby-docs -- npx -y shopby-mcp
```
### 使用
* **搜索 API 接口**：`search_apis(query, category?, limit?)`
* **浏览 API 接口**：`list_apis(tag?, category?, limit?)`
* **详细查询 API 接口**：`get_api_detail(operationId, source?, section?)`
## 配置和自定义
* **配置文件**：`claude_desktop_config.json`
* **环境变量**：`SHOPBY_MCP_MAX_AGE`、`SHOPBY_MCP_CACHE_DIR`、`SHOPBY_MCP_INDEX_URL`
## 常见问题
* **如何更新索引？**：可以使用 `--refresh` 参数或设置 `SHOPBY_MCP_MAX_AGE=0` 环境变量来强制更新索引。
* **如何自定义缓存目录？**：可以使用 `SHOPBY_MCP_CACHE_DIR` 环境变量来指定缓存目录。
## 未来计划
* **实现语义搜索**：可以通过添加向量搜索功能来实现语义搜索。
* **集成到公司内部系统**：可以将该工具集成到公司内部系统，如 Slack 机器人。
