# @haddowg/json-api-mcp 中文文档

规范地址：https://npmcn.com/package/%40haddowg/json-api-mcp/

版本：1\.26\.0
npm 元数据更新时间：2026-11-16T23:03:47.215Z
中文译文更新时间：2026-11-17T05:53:01.194Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40haddowg/json-api-mcp
原文对照：https://npmcn.com/package/%40haddowg/json-api-mcp/?lang=original
项目主页：https://haddowg.github.io/json-api-ts/mcp/
源码仓库：https://github.com/haddowg/json-api-ts

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

- 包体积（解压后）：556 kB，20 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=20
- 运行依赖：1 个
- peer 依赖：@haddowg/json-api-codegen ^2\.19\.0
- 首次发布：2026-10-28T15:09:24.725Z
- 最新版本发布：2026-11-16T23:03:46.892Z
- 近 30 天下载量：6724（2026-10-17 至 2026-11-15，npm 官方下载统计）
- 已发布版本数：38（近 12 个月 38 个）

## 中文简介

MCP工具定义和一个JSON:API服务器的调用处理器,服务于从它的OpenAPI文档在构建时生成的模型.

## 安装

```sh
npm install @haddowg/json-api-mcp
```

也可以使用：`pnpm add @haddowg/json-api-mcp`、`yarn add @haddowg/json-api-mcp`、`bun add @haddowg/json-api-mcp`

## README

# @ haddowg/ json- api- mcp

> **部分 [jsonapi.rest (英语)](https://jsonapi.rest/) 套间** - 完整、符合规格 JSON: API 1. 1 堆栈: 框架不可知 PHP [核心项目](https://github.com/haddowg/json-api)页:1 [符号捆绑](https://github.com/haddowg/json-api-symfony)页:1 [Laravel 软件包](https://github.com/haddowg/json-api-laravel),则 **键入类型脚本 客户端**,由经过检测的OpenAPI 3.1合同捆绑在一起. 完整文档: **[(原始内容存档于2018-10-21) (韩语). haddog.github.io/json-api-ts](https://haddowg.github.io/json-api-ts/)**。 。 。 .

MCP 工具定义和调用处理器 `haddowg/json-api` 服务器。 建设时间 生成器将服务器的 OpenAPI 文档转换成一个 JSON 模型, 由您执行 运行时间为每次收集、资源、相关和自定义操作服务一个工具, 在 OpenAI 和 Anthropic 的严格模式下, 输入方案是有效的。 呼叫通过 [`@haddowg/json-api-client`](https://npmcn.com/package/%40haddowg/client)。软件包没有MCP服务器:主机列表 工具,并传递电话给处理者.

## 安装

```bash
npm install @haddowg/json-api-mcp @haddowg/json-api-client
npm install --save-dev @haddowg/json-api-codegen
```

## 生成模型

```bash
npx @haddowg/json-api-mcp --input openapi/v5.json --output src/mcp/v5.mcp.json
npx @haddowg/json-api-mcp --input openapi/v5.json --output src/mcp/v5.mcp.json --check # in CI
```

这个模型产生,它的领先者 `$comment` 这么说的 重生而不是编辑 是手写的.

工具默认包含一个深层关系,所以每个工具的图案只包含其类型 直接关系到达。 过 `--include-depth <n>`,或 `all` 对于文档的每个路径 宣布,改变这一点.

操作可以用 `x-mcp` 供应商延伸. `false` 叶子 其工具出型号,以及 `name`, (中文(简体) ), `title` 财务报告和审定财务报表 `description` 替换这些 工具的部件.

已贬值的操作工具描述开始于 `Deprecated.`,一个 `x-mcp` 说明 包括,每个被折旧的属性、关系、过滤器和 排序工具输入中的密钥.

## 卖出它

来自无害环境管理或共同JS的运行时间负荷,仅需要客户端.

```ts
const { createJsonApiMcp } = require('@haddowg/json-api-mcp')

const mcp = createJsonApiMcp({ model: require('./mcp/v5.mcp.json') })
const session = await mcp.forRequest({ grantedScopes: token.scopes, context: { token } })
session.tools // answer tools/list with these
await session.callTool('albums_list', { sort: ['-releasedAt'], pageSize: 5 })
```

每个结果 `structuredContent` 是个类似API的信封 单项资源归来为 `{ data }`,集合为 `{ data, links, meta }` 只使用页形链接,删除为 `{ data: null }` 和只使用元的动作作为 `{ meta }`。平地资源保持链接 类型名称,例如预先签名的上传 URL,在 `links`。 。 。 .

来自 1.2: 返回 `{ data }` 返回地点 `{ item }`,创建或更新为 包起来 `{ data }` 而不是光着身子回来 收藏品列出了它的资源 `data` 改为 `items`删除返回 `{ data: null }` 而不是一行文字, a 纯元动作 `{ meta }` 代替赤色元对象, 和一个 URL 动作 `{ data: { url, type, expiresAt? } }` 而不是赤裸的物体。 重新生成模型以获得 新形状。 1.2生成的模型仍然装入并保持了1.2的形状 输出计划 说明。 这个 [移徙说明](https://haddowg.github.io/json-api-ts/mcp/#migrating-from-12) 掩护其他的.

范围过滤只计算打电话者凭其证书可以满足的安全要求 计划,文档的 `oauth2` 计划,除非你通过 `credentialSchemes`1\. 范围、特点 闸口、信头和错误提示来自可选钩: `scopeMatcher`, (中文(简体) ), `capabilities`, (中文(简体) ), `includeOperation`, (中文(简体) ), `decorateTool`, (中文(简体) ), `requestInit` 财务报告和审定财务报表 `mapError`见 [MCP 工具指南](https://haddowg.github.io/json-api-ts/mcp/)。 。 。 .

## 常见问题

### @haddowg/json-api-mcp 是什么？

MCP工具定义和一个JSON:API服务器的调用处理器,服务于从它的OpenAPI文档在构建时生成的模型\.

### 如何安装 @haddowg/json-api-mcp？

在项目目录运行 npm install @haddowg/json-api-mcp，或使用 pnpm add / yarn add / bun add。它还提供命令行工具 json-api-mcp，可以用 npx json-api-mcp 直接运行。

### @haddowg/json-api-mcp 支持 TypeScript 吗？

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

### @haddowg/json-api-mcp 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @haddowg/json-api-mcp 需要什么版本的 Node\.js？

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

### @haddowg/json-api-mcp 可以商用吗？

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

### @haddowg/json-api-mcp 的下载量有多少？

根据 npm 官方下载统计，@haddowg/json-api-mcp 在 2026/10/17 – 2026/11/15 这 30 天内被下载 6,724 次，日均约 224 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @haddowg/json-api-mcp 还在维护吗？

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

