Hurl OpenAPI MCP(模型上下文协议)服务器
一个强大的模型上下文协议(MCP)服务器,提供用于处理OpenAPI规范和Hurl文档的工具。该服务器使人工智能模型和工具能够与OpenAPI模式交互,并基于API规范生成Hurl测试文件。
目录
概述
该项目是一个使用Bun构建的MCP(模型上下文协议)服务器,该服务器将OpenAPI规范与Hurl(HTTP脚本语言)桥接起来,允许自动进行API测试、文档生成和模式检查。它使AI工具能够动态加载、检查和使用OpenAPI模式来生成适当的Hurl测试脚本。
特性
- OpenAPI规范管理:从本地文件或URL加载、存储和检索OpenAPI模式
- API架构检查:列出并检索有关API架构、路由、参数和安全方案的详细信息
- Hurl文档访问:检索Hurl文档以供学习和参考
- 点检:列出并检索有关API端点的详细信息,包括请求和响应架构
- 安全方案信息:访问OpenAPI规范中的安全定义
- 请求/响应模式检索:获取API终结点的特定架构信息
- MCP合规性:用于AI集成的完整模型上下文协议实现
安装
先决条件
- 包子 v1.3.0或更高版本
设置
- 克隆存储库:
git clone
cd hurl-openapi-mcp- 安装依赖项:
bun install用法
直接与面包一起使用,无需编译。
{
"mcpServers": {
"openapi-hurl": {
"command": "bun",
"args": [
"run",
"/home/oung/Projects/bun/hurl-openapi-mcp/src/index.ts"
]
}
},
}为了获得更好的测试体验,您可以使用 投掷测试计划器 定制代理,或者你可以自己调整。
或构建 bun run build,并使用以下输出 build/index.js默认目标为 bun。您可以将其更改为 node 通过手动编辑 . 默认情况下,服务器通过stdio运行。您可以将其连接到任何兼容MCP的客户端。
可用工具
服务器提供以下MCP工具:
OpenAPI规范管理
openapi_hurl:specifications:add-从JSON或YAML文件(本地或远程)加载OpenAPI规范openapi_hurl:specifications:list-列出所有加载的OpenAPI规范
架构操作
openapi_hurl:schemas:list-从指定的OpenAPI规范中获取所有模式名称openapi_hurl:schemas:retrieve-从OpenAPI规范中检索特定模式的详细信息
安全运营
openapi_hurl:security:list-从指定的OpenAPI规范中获取所有安全方案openapi_hurl:security:retrieve-检索特定安全方案的详细信息
路线运营
openapi_hurl:routes:list-列出指定OpenAPI规范中所有可用路由及其HTTP方法openapi_hurl:routes:retrieve-检索特定路线/端点的详细信息
请求/响应架构操作
openapi_hurl:requests:retrieve-从OpenAPI 3.x规范中检索特定端点的请求模式openapi_hurl:responses:retrieve-从OpenAPI 3.x规范中检索特定端点的响应模式
Hurl文档
openapi_hurl:hurl_document:retrieve-检索Hurl文档部分,包括:
- hurl_file:Hurl文件结构和语法 - entry:条目定义 - request:请求结构 - response:响应结构 - capturing_response:响应捕获技术 - asserting_response:响应断言 - filters:可用过滤器 - grammar:语法参考
许可证
此项目根据MIT许可证获得许可-请参阅 许可证 文件以获取详细信息。
贡献
- 分叉存储库
- 创建要素分支(
git checkout -b feature/amazing-feature) - 提交您的更改(
git commit -am 'Add amazing feature') - 推到分支(
git push origin feature/amazing-feature) - 打开拉取请求
支持
如需支持,请在存储库中打开问题。
