Trae Swagger

Parses Swagger/Knife4j API docs and makes them queryable inside Trae IDE.

typescript

0

GitHub Stars

typescript

Language

6 months ago

First Indexed

3 months ago

Catalog Refreshed

Documentation & install

Readme and setup notes from the catalogue, plus a client-ready config you can copy for your MCP host.

Installation

Add the following to your MCP client configuration file.

Configuration

View docs

{
  "mcpServers": {
    "qianyin-zhou-trae-swagger-mcp": {
      "command": "node",
      "args": [
        "D:/newer/trae-swagger-mcp/swagger-reader.js"
      ]
    }
  }
}

trae-swagger-mcp is an MCP tool built for Trae IDE that parses Swagger-based API documentation and converts its JSON structure into a query-friendly format you can easily inspect inside Trae IDE. This makes it practical to work with Swagger and Knife4j docs by providing direct, searchable access to interfaces and parameters without leaving your development environment.

How to use

Set up a local MCP server and use the Trae IDE smart agent to read and query Swagger documents. You will import the Swagger JSON, then prompt the agent to extract current endpoints, names, and parameters as you work.

How to install

Prerequisites: you need Node.js installed on your machine.

# Ensure Node.js is installed (example for version compatible with this tool)
# Install dependencies for the MCP
npm install

# Run tests to verify parsing behavior
npm run test

Configuration and usage notes

The MCP is configured to work with a local, stdio-based server that runs a Node script to read a Swagger JSON document and present it in Trae IDE.

Core configuration is exposed via the swagger-reader.js entry point, which reads the JSON document from a path you specify and formats it for Trae IDE.

Additional notes

If you modify the code, restart Trae IDE and test in a fresh project to verify the changes take effect.

Available tools

swagger-reader

Parses a Swagger/Knife4j JSON document and outputs a Trae IDE-friendly, queryable format.