内容
<p align="center">
<img src="https://raw.githubusercontent.com/Sannnao/react-docs-mcp/master/poster.png" width="100%" alt="React Hook Form 文档 MCP 服务器">
</p>
# React Hook Form 文档 MCP 服务器
为 Claude、Cursor 等 MCP 客户端提供基于 AI 的 React Hook Form 文档语义搜索服务。
另请参见：[react-docs-mcp](https://www.npmjs.com/package/react-docs-mcp)（React）和 [react-native-docs-mcp](https://www.npmjs.com/package/react-native-docs-mcp)（React Native）- 采用相同引擎。
## 🚀 安装（单命令）
### Claude 代码
```bash
claude mcp add --transport stdio react-hook-form-docs -- npx react-hook-form-docs-mcp
```
### Claude 桌面版
编辑：`~/Library/Application Support/Claude/claude_desktop_config.json`（macOS）或 `%APPDATA%\Claude\claude_desktop_config.json`（Windows）
```json
{
"mcpServers": {
"react-hook-form-docs": {
"command": "npx",
"args": ["-y", "react-hook-form-docs-mcp"]
}
}
}
```
### Cursor
**设置** → **Cursor 设置** → **工具和 MCP** → 添加服务器：
```json
{
"mcpServers": {
"react-hook-form-docs": {
"command": "npx",
"args": ["-y", "react-hook-form-docs-mcp"]
}
}
}
```
**完成！** 重启编辑器并询问有关 React Hook Form 的问题。
---
## 功能
- **🔑 无需 API 密钥**：与托管文档服务（Context7，GitMCP）不同，所有内容都在您的机器上运行 - 无需帐户，无需密钥，无需速率限制
- **🔌 离线工作**：克隆官方 react-hook-form 文档仓库一次，然后在本地搜索 - 查询时无需网络调用
- **🔍 语义搜索**：使用嵌入式 AI 进行概念匹配的搜索
- **⚡ 快速结果**：使用混合关键词 + 语义排名的内存向量搜索
- **📦 零配置**：与 `npx` 配合使用 - 无需安装
- **🤖 本地 AI**：在本地运行嵌入式（无需 API 成本）
- **📝 简洁的回复**：返回摘要而不是完整的文档
- **🔄 自动同步**：自动从官方文档仓库拉取最新的文档
## 用法
配置完成后，服务器为 AI 代理提供以下功能：
### 工具
#### `search_react_hook_form_docs`
搜索 React Hook Form 文档。
**参数**：
- `query`（必填）：搜索查询字符串
- `section`（可选）：按章节筛选（`docs` - API 参考；指南如 get-started 位于根目录，因此默认无筛选）
- `limit`（可选）：最大结果数（默认值：10，最大值：50）
**示例**：
```
在 React Hook Form 文档中搜索 "validate a field against another field"
```
#### `get_doc`
获取特定的文档页面。
**参数**：
- `path`（必填）：文档路径（例如 "docs/useform", "get-started"）
- `full`（可选）：返回完整的原始页面而不是约 1500 字符的摘要（默认值：false）
**为什么使用 `full`？** 默认摘要涵盖了大多数 API 查询，但长指南 - 高级用法，v7→v8 迁移指南 - 可能超过 1500 字符。请求完整页面时，摘要会被截断：
```
获取 React Hook Form 高级用法指南的完整内容
```
#### `list_sections`
列出所有可用的文档章节。
#### `update_docs`
从 Git 仓库拉取最新的文档。
### 命令行界面
```bash
npx react-hook-form-docs-mcp --version # 打印已安装的软件包版本并退出
```
### 资源
服务器通过 URI 模式公开文档资源：
```
react-hook-form-docs://{section}/{path}
```
## 限制
- **章节**：只有 `docs/`（API 参考）是真正的章节；指南页面（get-started, advanced-usage, faqs, ts, migrate-v7-to-v8）位于内容根目录 - 搜索时无筛选以涵盖所有内容。
- **MDX 渲染**：`.mdx` 独有语法（JSX 组件导入）被剥离为最佳文本，以便于搜索索引，因此某些页面的代码段可能包含多余的导入行。
## 开发
该软件包与 [react-docs-mcp](https://github.com/Sannnao/react-docs-mcp) 共享其引擎 - 开发工作在该 monorepo 中进行（此独立仓库是 `packages/react-hook-form-docs-mcp/` 的只读镜像；请在此处提交问题）。该软件包的源代码仅使用 React Hook Form 特定的默认值配置共享引擎 (`src/index.ts`)，并使用 [tsup](https://tsup.egoist.dev/) 独立打包。
```bash
npm install
npm run build
npm run dev # 直接使用 tsx 运行，无需构建步骤
```
## 许可证
MIT。React Hook Form 文档内容由 [react-hook-form/documentation](https://github.com/react-hook-form/documentation) 项目单独许可。
