# Postman MCP > Postman MCP Server connects your AI agent directly to your API development environment. It exposes Postman's entire resource graph—workspaces, collections, environments, and monitors—as actionable tools. You can list APIs, pull variable values, or check service status by simply asking your AI client, eliminating the need to click through dozens of complex UI tabs. ## Overview - **Category:** loved-by-devs - **Price:** Free - **Tags:** api-testing, api-documentation, request-management, collaboration, software-development ## Description ## Postman MCP Server: API Management, Done Right You'll connect your AI agent straight into your full API development playground. This server exposes every single piece of Postman—your workspaces, collections, environments, and monitors—as tools your agent can run. You don't gotta click through a dozen tabs or mess with complex UIs; you just tell your AI client what you need, and it handles the calls. ### What Your Agent Can Do Your AI agent acts like an API architect sitting right next to you. It gives you direct access to the entire resource graph of your Postman organization. You can list all accessible workspaces using `list_workspaces`, which shows every container where you keep your team's and personal projects. For APIs themselves, you can run `list_apis` to get a full rundown of all high-level API definitions in your account, including their schemas and versions. You also use `list_collections` to retrieve a list of every stored API collection by name or ID. Once you've got the specific collection ID, running `get_collection_details` pulls back all the detailed requests and metadata associated with it. When it comes to variables and settings, your agent uses `list_environments` to show all available variable sets—think 'Development,' 'Testing,' or 'Production.' If you know the specific environment, `get_environment_details` fetches every variable, their current values, and the whole configuration breakdown for that set. To make sure you're always working with fresh data, you can use `list_mocks` to view all your configured mock servers. This is key for testing responses before the actual backend service is even ready to go live. Your agent also handles infrastructure status checks. It runs `list_monitors` to retrieve the operational status and schedule details for every API performance monitor you've set up, while `list_environments` allows you to scope data by checking which variable sets are available across your whole account. You can pull all the necessary pieces of information—the definitions, the variables, the status checks—without ever leaving your conversation flow. ## Tools ### get_collection_details Retrieves the detailed requests and metadata for a specific API collection ID. ### get_environment_details Fetches all variables, their current values, and configuration details for a selected environment. ### get_workspace_details Retrieves the complete list of items and metadata belonging to a specific workspace. ### list_apis Lists all API definitions, providing high-level schemas and versions available in your account. ### list_collections Retrieves a list of every stored API collection by name or ID. ### list_environments Lists all available environment variable sets, like 'Development' or 'Production'. ### list_mocks Shows a list of configured mock servers, useful for simulating responses before the backend is ready. ### list_monitors Retrieves the status and schedule details for all set API performance monitors. ### list_workspaces Lists every accessible workspace, which is Postman's primary organizational container. ## Prompt Examples **Prompt:** ``` List all my Postman workspaces. ``` **Response:** ``` I've fetched your workspaces. You currently have access to: 'Core Payments API' (ID: ws-123) and 'Partner Integrations' (ID: ws-456). Which one would you like to explore? ``` **Prompt:** ``` Show me the items in collection ID [ID]. ``` **Response:** ``` Accessing collection... I found 8 requests inside. Key endpoints include 'POST /login' and 'GET /user/profile'. Would you like the full details of the '/user/profile' request? ``` **Prompt:** ``` Check the status of my API monitors. ``` **Response:** ``` Running the check... All 3 monitors are currently active. 'Production Health' passed its last run, while 'Staging API' reported a minor latency warning. Should I drill down into the 'Staging' results? ``` ## Capabilities ### List available workspaces Retrieves a list of every accessible workspace in your Postman organization. ### Fetch API definitions Lists all high-level APIs, including versions and schemas, that exist within the account. ### Retrieve collections by ID Gets detailed information and requests for a specific API collection. ### List environment variables Shows all available variable sets, allowing you to scope data for development or production stages. ### Check monitor status Lists and verifies the current operational state of scheduled API monitors. ### View mock server setup Retrieves a list of configured mock servers, useful for testing before implementation. ## Use Cases ### Validating Staging Readiness A QA tester needs to verify the 'Staging API' is healthy. Instead of navigating to the Monitoring tab and clicking through filters, they ask their agent: 'Check the status of all monitors.' The tool runs `list_monitors` and reports if latency warnings exist for the staging environment. ### Debugging a Missing Variable A developer is running code that fails because a required API key isn't found. They tell their agent to run `get_environment_details` on the 'Production' workspace. The agent pulls all variables and confirms if the specific key exists, solving the bug without leaving the terminal. ### Mapping Out Dependencies A Technical Lead is onboarding a new team member and needs an overview of all services. They ask the agent to run `list_workspaces` and then loop through `list_apis`. The agent structures this raw data into a readable, cross-functional service map. ### Testing Against Dummy Data A front-end developer needs to build a UI before the backend team finishes their API. They ask the agent to list available mock servers (`list_mocks`). The agent confirms the mock endpoint, allowing the dev to proceed with dummy data testing. ## Benefits - **Instant Variable Lookup:** Need to know the `user_id` for staging? Use `get_environment_details`. Your agent pulls the exact value from any environment set—no more clicking through 5 variable tabs. - **System Health Check:** Instead of checking a dashboard, ask your agent to run `list_monitors`. It reports the status (passed/failed) for all scheduled checks immediately. - **Clear Inventory Mapping:** Want to know what APIs exist? Use `list_apis` and `list_collections` together. You get an immediate, conversational map of every major resource in your account. - **Scope Management:** Need to focus on one area? Run `list_workspaces`. This tells you exactly which project containers are available, keeping your conversation scoped correctly. - **API Documentation Access:** Don't hunt for schemas. Use the agent to list APIs and collections (`list_apis`, `list_collections`). It hands you the definitions right in the chat. - **Pre-Build Testing:** Need a placeholder endpoint? Check `list_mocks`. You can confirm mock server existence, letting developers test against fake data before writing any code. ## How It Works The bottom line is: you talk to your API tools instead of navigating their UIs. 1. Subscribe to the Postman MCP Server and enter your API Key in the Vinkius Marketplace. 2. Tell your AI client what resource you need (e.g., 'Show me all staging environments'). 3. The agent executes the necessary tool (`list_environments`) and returns structured data, which it then presents conversationally. ## Frequently Asked Questions **How do I list all my Postman workspaces using get_workspace_details?** You first run `list_workspaces` to see all available containers. Then, if you want details on a specific one, you pass the ID to `get_workspace_details`. This is how your agent scopes its actions. **Can I use list_environments to check my API keys?** Yes. The tool runs `list_environments` and provides a view of all variable sets (like 'Dev' or 'Prod'). You can then ask the agent to run `get_environment_details` on the specific environment you need. **What is the difference between list_collections and get_collection_details?** Use `list_collections` when you just want an inventory of all available API collections. Use `get_collection_details` when you already know the ID and need to see the specific requests (POST/GET) inside that collection. **Does list_monitors tell me if my service is down?** It tells you if Postman's *monitor* is running successfully. It reports the status of scheduled checks, alerting you to potential performance issues or failures in your API endpoints. **When I use get_collection_details, how do I view all headers and body parameters for a request?** It returns the full payload structure for that endpoint. You'll get access to both HTTP headers and the body content used in that specific request, letting you check exact formats like JSON or form data. **What does list_mocks provide regarding my API's readiness for testing?** It lists every configured mock server. This confirms that the endpoints are set up to simulate responses, which is useful for development and testing before the actual backend service is finished. **If I need a list of all available top-level API definitions, should I use list_apis?** Yes, that's the right tool. It gathers every major API definition in your account. This view gives you the broadest scope by grouping multiple related collections and versions under one name. **Can I check variable security or usage limitations using get_environment_details?** Yes, the details include variable scopes and types. You can verify if a specific environment variable is marked as sensitive, restricted, or only available to certain deployment stages. **Can my AI automatically find the details of a specific collection just by providing its ID?** Yes! Use the `get_collection_details` tool with the unique ID. Your agent will respond with complete structure, requests, and metadata in seconds. **How do I check my API monitors status?** Simply ask the agent to run the `list_monitors` tool. It will compile all scheduled monitors and their latest results configured for your environment. **Does the integration permit modifying collections?** No. The core set of tools focuses strictly on querying and analyzing API context—listing workspaces, collections, and environments. State alteration operations are not currently exposed.