内容
# MCP Builder
该项目旨在将 OpenAPI 规范转换为 TypeScript 代码并生成 MCP Server。它提供了一种简单的方法，根据 OpenAPI YAML 文件中提供的定义生成 TypeScript 模式和处理程序。
> 该项目支持 OpenAPI v3，若要将 v2 转换为 v3，请查看此文档：[openapi3-parser](https://github.com/manchenkoff/openapi3-parser/blob/master/docs/recipes.md)
## 生成代码
要运行该项目，请激活 venv：
```bash
uv venv --python 3.12.9
source .venv/bin/activate
uv install
```
然后，您可以运行生成器脚本，将您的 OpenAPI YAML 文件转换为 TypeScript 代码。以下命令假设您有一个名为 `example/openapi_v3.yaml` 的 OpenAPI YAML 文件，并且您希望在 `output` 目录中生成 TypeScript 文件，使用位于 `src/templates` 目录中的模板。
```bash
python -m src.main --input=example/openapi_v3.yaml --output_dir=output --templates_dir=src/templates
```
或者
```bash
make run
```
## 准备 MCP Server
切换到 `output` 目录，创建 `.env` 文件并将您的环境变量放在那里，然后运行：
```bash
npm i
```
### 检查服务器
运行 `node dist/server.js`。您应该会看到启动消息。（MCP Server 正在运行 ...）
## 使用 MCP Server
### VsCode
在项目根目录中创建 `.vscode` 文件夹，并创建 `mcp.json` 文件。
```json
{
"servers": {
"gitlab": {
"command": "node",
"args": [
"/path/to/mcp_builder/output/dist/server.js" ## 根据您的路径更改
],
"env": {
"ACCESS_TOKEN": "ss", ## 更改为您的值
"API_URL": "ss" ## 更改为您的值
},
"type": "stdio"
}
}
}
```
### Cline
在您的设备中找到 `cline_mcp_settings.json` 并添加以下内容：
```json
{
"mcpServers": {
"gitlab": {
"disabled": false,
"timeout": 60,
"command": "node",
"args": [
"/path/to/mcp_builder/output/dist/server.js" ## 根据您的路径更改
],
"env": {
"ACCESS_TOKEN": "ss", ## 更改为您的值
"API_URL": "ss" ## 更改为您的值
},
"transportType": "stdio"
}
}
}
```
> 如果生成的工具超过 50 个，它们将不会显示在 Cline 列表中。您可以在 `src/templates/server.ts.j2` 中过滤列表并重新生成：
```typescript
...
server.setRequestHandler(ListToolsRequestSchema, async () => {
return {
tools: Object.entries(toolStore).slice(0,50).map(([name, tool]) => ({
name,
description: tool.definition.description,
inputSchema: tool.definition.inputSchema,
})),
};
});
...
```
MCP 市场