Swaggerhub
Accelerating API delivery and quality through standards and collaboration, built on OpenAPI
Verdict
Common use cases
- Pull API specs during incident triage
- Audit who has access to production APIs
- Compare endpoint changes across versions
- Update portal docs from Slack threads
- Share default API version with partners
Integration
- Vendor
- Swaggerhub
- Category
- developer-tools
- Auth
- API_KEY
- Tools
- 49
- Composio slug
swaggerhub
Tools
- Add Access Control for Teams
Tool to assign access control roles to teams on a SwaggerHub resource. Use when you need to grant team permissions (OWNER, DESIGNER, CONSUMER) for APIs, domains, projects, or portal products.
- Add Access Control for Users
Tool to assign access control roles to users on a SwaggerHub resource. Use when you need to grant user permissions (owner, designer, consumer) for APIs, domains, projects, organizations, teams, or portal products.
- Delete Table of Contents Entrydestructive
Tool to delete a table of contents entry from SwaggerHub portal. Use when you need to remove a table of contents entry by its ID. Optionally supports recursive deletion of nested entries.
- Get Access Control Users
Tool to retrieve the list of users assigned access control on a SwaggerHub resource. Use when you need to check who has access to an API, domain, project, organization, team, or portal product.
- Get API Default Version
Tool to get the default version identifier of a SwaggerHub API. Use when you need to know which version is marked as default for an API. This returns only the version identifier; to get the full API definition, use the version with GET /api
- Get API Definition
Tool to get the OpenAPI definition of a specified API version from SwaggerHub. Use when you need to retrieve the complete API specification including endpoints, schemas, and documentation for a specific API version.
- Get API Version Private Settings
Tool to get the visibility (public or private) of an API version. Use when you need to check whether a specific API version is publicly accessible or private.
- Get API Versions
Tool to retrieve a list of API versions for a specific API in SwaggerHub. Use when you need to get all versions of an API owned by an organization or user. Returns 404 if the specified API is not found or if the authenticated user does not
- Get Consumer Products
Tool to get a list of products that are visible to the consumer in a SwaggerHub portal. Use when you need to retrieve products from a portal, including both accessible and inaccessible products. This endpoint does not require authentication
- Get Domain Default Version
Tool to retrieve the default version identifier of a SwaggerHub domain. Use when you need to know which version is set as default for a domain before fetching its definition.
- Get domain definition
Tool to retrieve the OpenAPI definition of a specified domain version from SwaggerHub. Use when you need to access reusable domain components, schemas, or parameters.
- Get Domain JSON Definition
Tool to retrieve the OpenAPI definition for a specified domain version in JSON format. Use when you need to access the domain definition document from SwaggerHub.
- Get Domain Lifecycle Settings
Tool to get the published status for a specific domain and version in SwaggerHub. Use when you need to check if a domain version is published or unpublished.
- Get Domain Private Settings
Tool to retrieve the visibility (public or private) of a domain version in SwaggerHub. Use when you need to check whether a specific domain version is accessible publicly or restricted to private access.
- Get Domain Versions
Tool to get a list of domain versions from SwaggerHub. Use when you need to retrieve all versions of a domain definition and see which APIs reference it. The domain must exist and be accessible with the provided authentication. Returns doma
- Get Domain YAML Definition
Tool to retrieve the OpenAPI definition for a specified domain version in YAML format from SwaggerHub. Use when you need to fetch domain schemas or API specifications in YAML format.
- Get JSON API Definition
Tool to download OpenAPI definition as a JSON file from SwaggerHub Portal API. Use when you need to retrieve the API specification in JSON format.
- Get JSON Definition
Tool to get the OpenAPI definition for a specified API version in JSON format. Use when you need to retrieve the complete API specification from SwaggerHub. Returns the OpenAPI/Swagger definition which includes paths, operations, schemas, a
- Get lifecycle settings
Tool to get the published status for the specified API and version. Use when you need to check if an API version is published or unpublished.
- Get Organization Members
Tool to retrieve a list of organization members and their roles from SwaggerHub. Use when you need to view member details including email addresses, roles, and last activity. The authenticating user must be the organization owner.
- Get Organization Projects V2
Tool to get all projects of an organization in SwaggerHub. Use when you need to retrieve projects belonging to a specific organization. Projects organize APIs and domains into logical groups. Returns 403 if projects are not available in the
- Get Owner APIs
Tool to get a list of APIs for a specified owner in SwaggerHub. Use when you need to retrieve all APIs belonging to a specific user or organization. Results are returned in APIs.json format and can be paginated and sorted by various criteri
- Get owner domains
Tool to retrieve domains owned by a specific SwaggerHub user or organization. Use when you need to list all domains associated with an owner.
- Get Portal
Tool to retrieve information about a portal. Use when you need to fetch details about a specific SwaggerHub portal by its UUID or subdomain.
- Get Portal Access Requests
Tool to retrieve access requests for a portal in SwaggerHub. Use when you need to list all users who have requested access to a portal's products, with optional filtering by status or search query. Returns paginated results with details abo
- Get Portal Attachment
Tool to get informational attachment metadata from SwaggerHub Portal. Use when you need to retrieve details about a specific attachment by its UUID. This endpoint supports both authenticated and unauthenticated access for branding attachmen
- Get Portal Product
Tool to retrieve detailed information about a specific product resource. Use when you need to fetch complete details about a product using its UUID or portal-subdomain:product-slug identifier.
- Get Portal Products
Tool to get products for a specific portal that match your criteria. Use when you need to retrieve a list of products from a portal, with optional filtering by name or slug and pagination support.
- Get Portals
Tool to search for available portals. Returns portals where you have a designer role, either at the product level or organization level.
- Get Portal Templates
Tool to get templates for a specific portal that match your criteria. Use when you need to list or search for templates within a portal by name or other filters. Supports pagination for large result sets.
- Get Templates
Tool to retrieve a list of templates for an owner in SwaggerHub. Use when you need to get available templates for creating new API definitions or domain models.
- Get User Organizations
Tool to get organizations for a user. Use when you need to retrieve all organizations that the authenticating user is a member of. Results can be filtered by name using the q parameter, sorted by name or email, and paginated using page and
- Get User Roles
Tool to retrieve all roles assigned to a user across organization resources in SwaggerHub. Use when you need to check what permissions a user has across APIs, teams, domains, and other resources in an organization.
- Get YAML API Definition
Tool to download OpenAPI definition as a YAML file from SwaggerHub Portal API. Use when you need to retrieve the API specification in YAML format.
- Get YAML Definition
Tool to get the OpenAPI definition in YAML format for the specified API version from SwaggerHub. Use when you need to retrieve the API specification as YAML text for parsing, storage, or processing.
- List Attachments
Tool to retrieve all attachments for a portal or product. Use when you need to list attachments associated with either a specific portal or product. Provide either productId or portalId, not both.
- List Resource Types and Roles
Tool to list available resource types and assignable roles for each in a SwaggerHub organization. Use when you need to understand what roles can be assigned to different resource types like APIs, domains, projects, teams, and organizations.
- Remove Access Control for Teamsdestructive
Tool to remove access control for teams from a SwaggerHub resource. Use when you need to revoke team permissions from an API, domain, project, or portal product.
- Remove Access Control For Usersdestructive
Tool to remove access control for users from a SwaggerHub organizational resource. Use when you need to revoke user access to APIs, domains, projects, organizations, teams, or portal products.
- Remove Organization Membersdestructive
Tool to remove members from a SwaggerHub organization. Use when you need to revoke membership for one or more users by their email addresses.
- Search APIs
Tool to search SwaggerHub APIs. Use when you need to find API definitions in SwaggerHub by name, owner, or other criteria. This is a convenience alias for GET /specs?specType=API.
- Search APIs and Domains
Tool to search SwaggerHub APIs, domains, and templates. Use when you need to retrieve a list of currently defined APIs, domains, and/or templates in APIs.json format. Supports filtering by spec type, visibility, state, owner, and free text
- Search Domains
Tool to search SwaggerHub domains. Use when you need to find domain definitions in SwaggerHub by name, owner, or other criteria. This is a convenience alias for GET /specs?specType=DOMAIN.
- Search Published Portal
Tool to search published portal content. Use when you need to search for APIs, operations, schemas, or documents within a specific SwaggerHub portal. This endpoint does not require authentication for public content, but authentication provi
- Update Access Control for Teams
Tool to update access control for teams on a SwaggerHub resource. Use when you need to grant or modify team permissions for an API, domain, project, or portal product.
- Update Access Control for Teams
Tool to update access control roles for teams on a SwaggerHub resource. Use when you need to assign or change team permissions (designer or consumer) for APIs, domains, projects, or portal products.
- Update Access Control for Users
Tool to update access control roles for users on a SwaggerHub resource. Use when you need to assign or change user permissions (owner, designer, consumer) for APIs, domains, projects, organizations, teams, or portal products.
- Update Access Control Users
Tool to update access control roles for users on a SwaggerHub resource. Use when you need to change user permissions (CONSUMER, DESIGNER, or OWNER) for APIs, domains, projects, organizations, teams, or portal products.
- Update Portal
Tool to update specific portal information in SwaggerHub. Use when you need to modify portal settings such as name, branding, subdomain, or other configuration options.
Setup
Setup guide
- 11. In Switchy, open your workspace settings and navigate to the Integrations tab. 2. Find SwaggerHub in the MCP directory and click Connect. 3. You'll be prompted to enter a SwaggerHub API key — generate one in your SwaggerHub account under Settings > API Key (requires Owner or Designer role). 4. Copy the key and paste it into Switchy's connection dialog, then click Authorize. 5. Switchy will test the connection by listing your accessible APIs; if it succeeds, you'll see a confirmation message. 6. Open any Space and type '@SwaggerHub get API definition for [owner]/[api]/[version]' to test retrieval. 7. If the tool returns a 404 or permission error, verify your API key has read access to the target resource in SwaggerHub's access control settings.
What teammates see: by default, memories from Swaggerhub are scoped to the Space (PROJECT visibility) - you can mark any memory PRIVATE or share it ORG-wide.
Works well with
Top models
Compatibility data appears once enough Spaces have used this MCP together with a given model.
How Switchy teams use it
Starter prompts
Fetch Production API Spec
@SwaggerHub get the API definition for our production payment API (owner: acme-corp, api: payments-api, version: v2.1) and summarize the available endpoints.Open in a Space →
Check API Visibility
@SwaggerHub check if version 3.0 of the user-service API (owner: acme-corp) is set to public or private, then explain what that means for external access.Open in a Space →
List All API Versions
@SwaggerHub list all versions of the orders-api owned by acme-corp and highlight which one is currently marked as default.Open in a Space →
Audit Access Permissions
@SwaggerHub get the list of users who have access to the internal-analytics API (owner: acme-corp) and show their roles (owner, designer, consumer).Open in a Space →
Grant Team Access
@SwaggerHub add the mobile-team as consumers on the notifications-api (owner: acme-corp, api: notifications-api) so they can view the spec.Open in a Space →
Example outputs
Illustrative - representative of the model's voice and quality, not literal recordings.
@swaggerhub show me the full OpenAPI spec for our payments-api version 2.1.0 and list all the POST endpoints
Retrieved the OpenAPI 3.0 definition for payments-api v2.1.0. The spec contains 4 POST endpoints: `/payments/create` (initiates a new payment transaction), `/payments/refund` (processes refunds), `/payments/webhooks/register` (subscribes to payment events), and `/payments/batch` (handles bulk payment processing). Each endpoint includes request/response schemas, authentication requirements, and example payloads. The API uses OAuth 2.0 bearer tokens and returns standardized error codes.
This example demonstrates SwaggerHub's core capability: retrieving complete API specifications. Requires READ access to the API resource. The response includes the full OpenAPI document, which can be large (often 500+ lines) for production APIs. Consider asking the AI to filter or summarize specific sections rather than displaying the entire spec.
@swaggerhub grant DESIGNER access to sarah.chen@company.com for our customer-api project so she can edit the spec
Successfully granted DESIGNER role to sarah.chen@company.com on the customer-api project. Sarah can now edit API definitions, update documentation, and manage versions within this project. She cannot delete the project or modify access control settings (those require OWNER role). The change takes effect immediately and Sarah will receive an email notification about the new access.
This showcases SwaggerHub's access control management. Requires OWNER permissions on the target resource to execute. Be cautious: granting DESIGNER access allows the user to modify live API specs, which could affect dependent systems. SwaggerHub supports three roles (OWNER, DESIGNER, CONSUMER) with different permission levels—verify the appropriate role before granting.
@swaggerhub compare all versions of our auth-service API and tell me what breaking changes were introduced between v1.3.0 and v2.0.0
Retrieved 8 versions of auth-service (v1.0.0 through v2.1.0). Comparing v1.3.0 to v2.0.0 reveals three breaking changes: (1) The `/auth/login` endpoint now requires a `device_id` field (previously optional), (2) The `refresh_token` response field was renamed to `refreshToken` (camelCase), and (3) The deprecated `/auth/validate` endpoint was removed entirely—clients should use `/auth/verify` instead. Additionally, v2.0.0 added OAuth 2.0 PKCE support and introduced rate limiting headers.
This example pairs SwaggerHub's version-listing capability with AI reasoning to identify breaking changes. The AI analyzes structural differences between OpenAPI specs—useful for migration planning. Note that SwaggerHub doesn't natively track "breaking vs. non-breaking" changes; the AI infers this from schema modifications. For large APIs, specify which endpoints or schemas to focus on to avoid token-heavy responses.
Use-case deep-dives
When SwaggerHub MCP makes sense for multi-team API sprawl
A 20-person engineering org with 8 microservices and 3 product teams needs a single source of truth for who can edit which API specs. The SwaggerHub MCP wins here because it surfaces access control and versioning directly in Switchy—your tech lead can audit who has designer vs. consumer roles on each API without context-switching to the SwaggerHub UI. The 49 tools cover the full lifecycle: check default versions, pull definitions, toggle private settings, manage team permissions. This works if your team already uses SwaggerHub as the spec registry. If you're just storing OpenAPI files in GitHub and don't need role-based access, the filesystem MCP is simpler. Use this when API governance is a real problem, not a hypothetical one.
SwaggerHub MCP for keeping public docs current
A 3-person DevRel team publishes API docs to a SwaggerHub portal and needs to keep the table of contents in sync with new endpoint releases. The SwaggerHub MCP lets you script TOC updates and visibility toggles from Switchy without manually clicking through the portal admin. You can check which API versions are public, add new entries when a v2 ships, and delete deprecated sections—all in one workspace alongside your release checklist. This is overkill if you publish docs once a quarter; it pays off when you're shipping weekly and the portal is customer-facing. The access control tools also help if you're coordinating with external partners who need consumer-level access to specific APIs. Use this if portal maintenance is eating more than 2 hours a week.
When SwaggerHub MCP speeds up contractor API discovery
A 5-person startup brings on a contractor to build a new integration against 4 internal APIs, but the specs live in SwaggerHub and the contractor doesn't have logins yet. The SwaggerHub MCP lets your eng lead pull the full OpenAPI definitions into Switchy, grant the contractor consumer access, and share the specs in one conversation—no waiting for IT to provision accounts. The contractor can see which version is default, check if an endpoint is private, and ask questions about the schema without bouncing between Slack and the SwaggerHub UI. This breaks down if your APIs aren't documented in SwaggerHub or if the contractor needs to edit specs (then they need a real account). Use this when you're onboarding someone who needs read access fast and you want to avoid the SwaggerHub login ceremony.
Frequently asked
What does the SwaggerHub MCP do in Switchy?
It lets your team read and manage OpenAPI specs stored in SwaggerHub—check which version is default, pull definitions, assign access control to users or teams, and edit portal table-of-contents entries. You can automate API documentation workflows without leaving Switchy's chat interface.
Do I need admin access to connect SwaggerHub?
You need a SwaggerHub API key with permissions matching what you want to do. Reading API definitions works with consumer-level keys; assigning access control or changing default versions requires owner or designer permissions on the relevant resources. Generate the key in your SwaggerHub account settings.
Can the MCP publish new API versions to SwaggerHub?
No. The 49 tools focus on reading specs, managing access control, and organizing portal content. If you need to push updated OpenAPI files or create new versions, use SwaggerHub's Git integration or their REST API directly—this MCP won't replace your CI pipeline.
Why use this instead of SwaggerHub's web UI?
The MCP shines when you're already working in Switchy and need to check which team has access to an API, grab a definition for a prompt, or verify the default version. It's faster than context-switching to the SwaggerHub dashboard for read-heavy tasks, but the web UI remains better for visual spec editing.
Who on the team should connect the SwaggerHub MCP?
Whoever owns your API documentation workflow—usually a tech lead or platform engineer. They'll generate the API key and connect it in Switchy. Other team members can then invoke the tools in shared chats without needing their own SwaggerHub credentials, as long as the connected key has the right permissions.