# Insomnia (Collaborative API Design) MCP for AI Agents AI Agent Connect > Insomnia (Collaborative API Design) lets you manage your entire API development lifecycle from a single chat interface. You can navigate organizations, browse projects, and inspect design documents or request collections without switching tabs. It also lets your agent audit environment configurations, monitor mock statuses, and pull OpenAPI specifications directly into your workflow. It's built for teams who need to keep their API designs organized and accessible. ## Overview - **Category:** loved-by-devs - **Price:** Free - **Endpoint:** https://edge.vinkius.com/vk_preview_llyGrXZujRu3thzxemiC8Hu0c2yGytKkiHgDZtDU/ai-agent-connect - **Tags:** api-design, rest-api, graphql, debugging, api-testing, websocket ## Description Managing a growing set of API specifications usually involves jumping between different tabs, searching through nested folders, and constantly checking if a mock is actually live. This Connector changes that by letting you talk to your API data instead of digging for it. You can ask your agent to find a specific project, pull the latest OpenAPI spec, or check who has access to a certain organization. It takes the friction out of collaborative design by making your entire Insomnia Cloud account searchable and actionable. If you're tired of hunting for the right environment variables or trying to remember which branch a design file lives on, this tool handles the heavy lifting. You can audit your team's progress, check mock statuses, and see what your AI-powered request logs are suggesting for better quality. It connects your design workspace to your primary workspace, making it easier to stay in your flow state. You'll find that having this integrated through Vinkius makes it much simpler to keep your API documentation in sync with your actual development work. ## Tools ### list_orgs Find your organization ID to start looking for projects or files. It returns names and member counts. ### list_projects See all team projects in an organization. This helps you navigate different API design environments. ### list_files Locate specific API specs or request collections in a project. It returns names and types. ### get_file Pull the full content and version history of an API design file. This works for both specs and collections. ### list_branches See the status of different feature branches for your API specs. This tracks collaborative progress. ### list_collaborators Check the usernames and roles of everyone in your organization. Use this to audit team permissions. ### list_ai_requests View metrics and metadata for AI-generated API requests. This helps you see AI-powered test suggestions. ### get_user View your own profile, plan, and organization memberships. This helps audit your own identity context. ### list_environments See the variables and base URLs for your different deployment stages. This shows your environment configurations. ### list_mocks Find the names, URLs, and statuses of your mocks. This helps you verify your testing infrastructure. ## Prompt Examples **Prompt:** ``` What projects do we have in our organization? ``` **Response:** ``` I've found the following projects in your organization: | Project Name | Project ID | | :--- | :--- | | **Payments API** | `proj_987` | | **User Auth** | `proj_654` | | **Inventory Sync** | `proj_321` | Which one would you like to explore? ``` **Prompt:** ``` Can you show me the OpenAPI spec for the 'Auth' file? ``` **Response:** ``` Retrieving the 'Auth' design file... I've pulled the content. It contains a full **OpenAPI 3.0 specification** with the following details: * **Endpoints:** 8 total * **Auth Methods:** Bearer Token, API Key * **Base URL:** `https://api.example.com/v1` Would you like me to summarize the specific paths for you? ``` **Prompt:** ``` Which mock statuses are active in the 'Inventory' project? ``` **Response:** ``` Here is the current status of the mocks in the **Inventory** project: * **Production Mock:** ✅ Active (`https://mock.example.com/inv`) * **Beta Mock:** ❌ Inactive * **Legacy Mock:** ⚠️ Warning (`https://mock.example.com/old`) Do you want me to check the environment variables for the Production Mock? ``` ## Capabilities ### Fetch OpenAPI and Swagger specs Pull full design documents and request collections into your chat for immediate review. ### Audit project environments Check base URLs and variable counts across different deployment stages quickly. ### Monitor mock statuses See the operational state and URLs of your mocks without opening the desktop app. ### Track collaborative branches View the status of parallel feature branches for your API specifications. ### Identify team permissions Get a clear list of members, roles, and access levels within your organization. ### Retrieve design content Get the exact payload and version history of any specific file in a project. ## Use Cases ### Verifying staging environment variables A developer asks their agent to find the base URL and auth tokens for the staging environment. The agent uses list_environments to pull the data instantly. ### Checking mock status for a new feature A QA engineer wants to know if the inventory mock is active. They ask the agent, which uses list_mocks to confirm the URL and status. ### Retrieving specs for a code review An architect needs to see the latest OpenAPI spec for the payments API. They ask the agent to pull the file using get_file. ### Auditing team permissions An admin needs to see who has admin rights in the organization. They ask the agent to list_collaborators to get a full role breakdown. ## Benefits - Pull OpenAPI specs instantly using get_file instead of searching through folders and clicking through menus. - Keep your team aligned by checking roles and permissions with list_collaborators to see who has access. - Audit your deployment stages quickly using list_environments to see all active variables for every stage. - Monitor your testing infrastructure by checking mock statuses with list_mocks to ensure your mocks are live. - Track parallel work easily by viewing different feature branches with list_branches to see branch statuses. - Review AI-driven suggestions for your API quality using list_ai_requests to see generated test suggestions. ## How It Works The bottom line is you get a natural language interface for your entire Insomnia Cloud workspace. 1. Connect your Insomnia Cloud account by providing your Personal Access Token. 2. Ask your agent to find specific projects, files, or environment variables. 3. Get immediate access to your API specs, mock statuses, and team data. ## Frequently Asked Questions **How can I use the Insomnia (Collaborative API Design) MCP to manage my team's API specs?** You can use it to browse projects, find specific files, and pull full OpenAPI specifications directly into your chat. It makes it easy to get the information you need without leaving your agent. **Can I check my mock statuses with the Insomnia (Collaborative API Design) MCP?** Yes. You can ask your agent to list the mocks in a project, and it will provide you with their names, URLs, and current operational statuses. **Does the Insomnia (Collaborative API Design) MCP work with my existing Insomnia Cloud account?** It does. By connecting your Insomnia Cloud account with your Personal Access Token, the Connector gives your agent the ability to interact with your existing organizations, projects, and files. **How do I find environment variables using the Insomnia (Collaborative API Design) MCP?** Just ask your agent to list the environments for a specific project. It will return the environment names and the count of variables configured for each stage. **Can I see who has access to my projects using the Insomnia (Collaborative API Design) MCP?** Yes. You can ask the agent to list the collaborators in your organization, and it will show you the usernames, emails, and roles for all members. **Can I see the history of my API design files?** Yes, when you use the agent to get a specific file, it retrieves the full content along with the version history, so you can see how the design has evolved. **Can I fetch full OpenAPI specifications through my agent?** Yes. Use the `get_file` tool by providing the relevant Org, Project, and File IDs. Your agent will retrieve the exact content payload, allowing you to inspect or summarize the API structure directly in your workspace. **How do I see the environments defined in a team project?** The `list_environments` tool allows your agent to extract base environments scoped within a project. You'll see the environment names and variable counts, helping you identify available stages for your API calls. **Can my agent check if a mock server is currently online?** Absolutely. Use the `list_mocks` tool to retrieve all mock servers linked to your projects. Your agent will report their current operational state, names, and hosted URLs for testing purposes.