Rest To Postman

🚀 REST-to-Postman MCP

A Model Context Protocol (MCP) server that converts REST API code (such as NestJS controllers, FastAPI/Flask endpoints) into Postman collections and environments. This tool helps developers automatically synchronize their REST API endpoints and environment configurations with Postman.

✨ Features

• Convert REST API endpoints into Postman collections.
• Synchronize environment variables to Postman environments.
• Support multiple authentication methods (e.g., Bearer tokens).
• Intelligently merge new endpoints into existing collections.
• Automatically handle sensitive environment variables.
• Support two modes: REST and real-time feedback.

📦 Installation and Usage

Run via npx

npx rest-to-postman-mcp

Install via Smithery

1. Visit smithery.ai.
2. Follow the instructions for setup and deployment.

📚 Documentation

Start the Server

# Start in default mode
npx rest-to-postman-mcp

# Start in real-time feedback mode
npx rest-to-postman-mcp --sSE

Create a Configuration File

Create a .env file:

POSTMAN_API_KEY=Your Postman API key
POSTMAN_ACTIVE_WORKSPACE_ID=Your Postman active workspace ID

💻 Usage Examples

Basic Usage

import { type } from 'class-transformer'
import {
  Body,
  Controller,
  Delete,
  Get,
  HttpCode,
  Param,
  Post,
  Put,
} from 'nestjs'

@Controller('users')
export class UsersController {
  @Post()
  @HttpCode(201)
  async createUser(@Body() user: UserDto) {
    return { message: '用户创建成功' }
  }

  @Get()
  findAll() {
    return { message: '获取所有用户' }
  }

  @Get(':id')
  findOne(@Param('id') id: string) {
    return { message: '获取单个用户', id }
  }

  @Put(':id')
  update(@Param('id') id: string, @Body() user: UserDto) {
    return { message: '更新用户', id }
  }

  @Delete(':id')
  remove(@Param('id') id: string) {
    return { message: '删除用户', id }
  }
}

The automatically generated Postman collection:

All endpoints defined in UsersController will be automatically generated and include Bearer token settings.

Local Development

Clone the Repository

git clone https://github.com/runninghare/rest-to-postman.git
cd rest-to-postman

Install Dependencies

bun install

Create a Configuration File

Create a .env file:

POSTMAN_API_KEY=Your Postman API key
POSTMAN_ACTIVE_WORKSPACE_ID=Your Postman active workspace ID

Run in Development Mode

# Run in default mode
bun run src/mcp.ts

# Run in real-time feedback mode
bun run src/mcp.ts --sSE

Build the Project

bun run build

After the build is complete, the output files will be located in the dist directory.

Script Commands

• bun run build - Build the project.
• bun run dev - Run the server in development mode.
• bun run startSSE - Start the server in real-time feedback mode.

Contribution

Contributions are welcome! Please feel free to submit a Pull Request.

📄 License

This project is licensed under the MIT License. Please refer to the LICENSE file for details.