# @faapi/schema 中文文档

规范地址：https://npmcn.com/package/%40faapi/schema/

版本：7\.21\.0
npm 元数据更新时间：2026-10-31T23:21:33.658Z
中文译文更新时间：2026-11-01T03:11:49.778Z
软件包许可：MIT

本文由上游 README 机器翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40faapi/schema
原文对照：https://npmcn.com/package/%40faapi/schema/?lang=original
项目主页：https://github.com/faapi/faapi#readme
源码仓库：https://github.com/faapi/faapi

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：48.4 kB，7 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=24
- 运行依赖：0 个
- peer 依赖：zod ^4\.4\.3，@faapi/mcp ^7\.21\.0，typescript \>=5\.7\.0，@faapi/faapi ^7\.21\.0
- 首次发布：2026-06-28T07:28:25.544Z
- 最新版本发布：2026-10-31T23:21:33.022Z
- 已发布版本数：143（近 12 个月 143 个）

## 中文简介

faapi的模式自省——通过MCP向AI助手公开API模式

## 安装

```sh
npm install @faapi/schema
```

也可以使用：`pnpm add @faapi/schema`、`yarn add @faapi/schema`、`bun add @faapi/schema`

## README

# @faapi/schema

> 将 faapi 路由 schema 通过 MCP 协议暴露给 AI 助手

`@faapi/schema` 是 faapi 的扩展包，基于 [`@faapi/mcp`](https://npmcn.com/package/%40faapi/mcp/)（纯手写 MCP Server SDK）构建 MCP Server，通过 Streamable HTTP transport 在 `/mcp` 端点暴露路由 schema，让 AI 助手（如 Claude、Codex）能查询你的 API 路由结构、参数类型，无需阅读源代码即可理解接口定义。

不依赖 `@modelcontextprotocol/sdk`，MCP 协议层完全由 `@faapi/mcp` 实现。

## 安装

```bash
pnpm add @faapi/schema
# 或
npm install @faapi/schema
```

要求 Node.js >= 24。

## 快速开始

在 `faapi.config.ts` 中声明插件：

```ts
export default {
  plugins: ['@faapi/schema'],
} satisfies FaapiConfig;
```

启动 dev server 后，MCP 端点自动挂载到 `/mcp` 路径。插件声明即为开关——不需要时从 `plugins` 数组移除即可，也可用 `{ package: '@faapi/schema', enable: false }` 临时禁用。

## MCP 工具

| 工具名 | 功能 |
| --- | --- |
| `list_routes` | 列出所有 HTTP 路由（方法、路径、是否动态路由） |
| `get_route_schema` | 获取单个路由的详细输入参数（名称、类型、是否必填） |
| `get_api_schema` | 获取所有路由的完整 schema（类似 OpenAPI） |

## MCP 客户端配置

AI 助手通过 Streamable HTTP 连接到 `http://localhost:3000/mcp`（端口取决于 `PORT` 环境变量）。以支持 HTTP transport 的 MCP 客户端为例：

```json
{
  "mcpServers": {
    "faapi": {
      "url": "http://localhost:3000/mcp"
    }
  }
}
```

连接流程：`POST /mcp` 发送 `initialize` 请求 → 从响应 `Mcp-Session-Id` header 获取会话 ID → 后续 `tools/list`、`tools/call` 请求携带该 header → `DELETE /mcp`（带 session header）销毁会话。

## 许可证

[MIT](https://github.com/faapi/faapi/blob/main/LICENSE)

## 常见问题

### @faapi/schema 是什么？

faapi的模式自省——通过MCP向AI助手公开API模式

### 如何安装 @faapi/schema？

在项目目录运行 npm install @faapi/schema，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：zod（^4\.4\.3）、@faapi/mcp（^7\.21\.0）、@faapi/faapi（^7\.21\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @faapi/schema 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @faapi/schema 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @faapi/schema 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=24。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @faapi/schema 可以商用吗？

@faapi/schema 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @faapi/schema 还在维护吗？

最新版本 7\.21\.0 发布于 2026/11/01（2 天前）；至今共发布 143 个版本，其中过去 12 个月发布了 143 个；首次发布于 2026/06/28。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。