@ frontmcp/ 适应器
FrontMCP服务器的适配器. 一个适配器在服务器启动时从另一个来源建立工具. 这个软件包 OpenapiAdapter,它读取了一个 REST API 的 OpenAPI 3 描述,并且每次操作都会给您的应用一个工具,这样您就可以将您已经拥有的 API 放在模型前,而不为每个端点写一个工具 .
安装
npm install @frontmcp/adapters
在 FrontMCP 应用程序中使用:它取决于 @frontmcp/sdk,所以两者保持同一版本. 它需要节点.js 24或后.
使用量
列出 OpenapiAdapter.init() 在应用程序 adapters数字 :
import { OpenapiAdapter } from '@frontmcp/adapters';
import { App } from '@frontmcp/sdk';
@App({
id: 'petstore',
name: 'Pet Store',
adapters: [
OpenapiAdapter.init({
name: 'petstore',
url: 'https://petstore3.swagger.io/api/v3/openapi.json',
baseUrl: 'https://petstore3.swagger.io/api/v3',
}),
],
})
export class PetStoreApp {}
所需的选项 :
| 选项 | 类型 | 说明 |
|---|---|---|
name | string | 命名适配器。 在这个过程中它必须是独一无二的,并且前缀一个其名称与另一个工具相冲突的工具. |
baseUrl | string | API所在之处. 每个操作的路径都附着在其上, 它胜过Spec's servers。 。 。 . |
spec 或者说 url | object 或者说 string | OpenAPI 3.0 或 3.1 文档作为对象,或 http: 或者说 https: URL 从服务器启动时下载它 . |
每个工具在发出请求之前先检查其针对操作参数和机体计划的论点. 其他选项设置全权证书staticAuth, (中文(简体) ), authProviderMapper, (中文(简体) ), securityResolver,过滤和重命名操作(generateOptions, (中文(简体) ), toolTransforms),在服务器上填写输入(inputTransforms),重塑反应(dataTransforms),并在服务器运行时重读光谱(polling) (中文(简体) ). OpenAPI 适配器 文档每个选项.
解析光谱并生成工具由 mcp-from-openapi。 。 。 .
入境点
| 导入 | 它有什么东西 |
|---|---|
@frontmcp/adapters | OpenapiAdapter, (中文(简体) ), OpenApiSpecPoller,以及 OpenAPI 帮助和类型. |
@frontmcp/adapters/openapi | 相同的 OpenAPI 导出, 与 OpenapiAdapter 作为默认导出. |
@frontmcp/adapters/skills | 技能捆绑源和捆绑店 @frontmcp/plugin-skilled-openapi。 。 。 . |
根和(或) /openapi 各入口单独建起,每个入口都有自己的副本 OpenapiAdapter,所以从其中之一 导入整个应用程序.
文档
- OpenAPI 适配器: 每一个选项, 证书, 转换和光谱投票
- 环绕 OpenAPI 服务:分步骤指南
- OpenAPI 的宠物存储:一个完整的API包裹并适合一个模型
@Adapter: 自己写一个适配器
相关软件包
@frontmcp/sdk:适配器插入的框架.@frontmcp/plugin-skilled-openapi: 对于一个 API 太大而不能列为工具.@frontmcp/testing:适配器生成的工具的端到端测试.mcp-from-openapi: 下面的 OpenAPI 到 MCP 转换器.
捐款
资料来源: libs/adapters欢迎提出问题和拉动请求;见 捐款额。 。 。 .
许可证
阿帕奇2.0 (英语). 见 自由主义。 。 。 .