Frequently Asked Questions about REST-to-Postman MCP Server

Q: What is the REST-to-Postman MCP server?

A: The REST-to-Postman MCP server is a Model Context Protocol (MCP) server that automates the conversion of REST API code (e.g., NestJS controllers, FastAPI/Flask endpoints) into Postman collections and environments. It helps developers automatically sync their REST API endpoints and environment configurations with Postman.

Q: What are the prerequisites for using the REST-to-Postman MCP server?

A: The prerequisites include:

• Bun v1.2.2 or later
• Postman API Key
• Postman Workspace ID

Q: How do I install the REST-to-Postman MCP server?

A: You can install the server via Smithery or using npx:

• Via Smithery: npx -y @smithery/cli install @runninghare/rest-to-postman-mcp --client claude
• Via npx: npx -y rest-to-postman@latest --postman-api-key your_api_key --postman-workspace-id your_workspace_id

Q: What is a Postman API Key and how do I get one?

A: A Postman API Key is a unique identifier that allows the MCP server to access and modify your Postman workspace. You can generate an API key in your Postman account settings.

Q: What is a Postman Workspace ID and how do I find it?

A: A Postman Workspace ID identifies the specific workspace where your collections and environments will be created or updated. You can find the Workspace ID in the URL of your Postman workspace.

Q: What tools does the server provide?

A: The server provides two main tools:

• rest_to_postman_env: Creates or updates a Postman environment with your application’s environment variables.
• rest_to_postman_collection: Creates or updates a Postman collection with your REST API endpoints.

Q: How do I use the rest_to_postman_env tool?

A: The rest_to_postman_env tool takes two input parameters:

• envName (string): Name of the Postman environment
• envVars (object): Key-value pairs of environment variables

Q: How do I use the rest_to_postman_collection tool?

A: The rest_to_postman_collection tool takes a collectionRequest object as input, which includes:

• info: Collection metadata
• auth: Authentication settings
• item: Array of API endpoints

Q: Can I integrate this MCP server with AI code editors?

A: Yes, you can integrate this MCP server with AI code editors like Claude Desktop, Cursor, Windsurf, and Roo Cline Editor.

Q: What is the Model Context Protocol (MCP)?

A: MCP is an open protocol that standardizes how applications provide context to LLMs (Language Model Models). The MCP server acts as a bridge, allowing AI models to access and interact with external data sources and tools.

Q: Where can I find more information about UBOS?

A: UBOS is a full-stack AI Agent Development Platform focused on bringing AI Agents to every business department. Visit https://ubos.tech for more information.