The Swagger MCP connector routes your AI agent's tool calls to Swagger's own MCP server through Scalekit. Each user signs in to Swagger once, and Scalekit stores and refreshes their tokens, so your agent never handles credentials. It comes with 28 tools.
- Tools
- 28
- What they doRead · write · destructive
- 12 · 7 · 912 read7 write9 destructive
- Users sign in with
- OAuth
- OAuth app
- Scalekit's or your own
What you can do
- Search and fetch APIs: find APIs and domains in the SwaggerHub registry and read their resolved definitions
- Create and update APIs: save new OpenAPI or AsyncAPI definitions, or generate one from a plain-language prompt
- Check API standards: scan definitions against your organization’s governance rules and fix the errors they find
- Manage portals and products: create, update, and publish developer portal products, live or as a preview
- Organize portal docs: add, edit, and delete documentation pages and table of contents entries in product sections
Setup
Install the SDK
Terminal window npm install @scalekit-sdk/node dotenvTerminal window pip install scalekit-sdk-python python-dotenvSet your credentials
Add your Scalekit credentials to your
.envfile. Find values in app.scalekit.com > Developers > API Credentials..env SCALEKIT_ENVIRONMENT_URL=<your-environment-url>SCALEKIT_CLIENT_ID=<your-client-id>SCALEKIT_CLIENT_SECRET=<your-client-secret>Create the Swagger MCP connection
In AgentKit > Connections, create a Swagger MCP connection. The name you give it is the
connection_nameyour code passes. See Configure connections.Scalekit credentials are available for Swagger MCP server, so you don't need to register an OAuth app.
Authorize a user and make your first call
quickstart.mts import { ScalekitClient } from '@scalekit-sdk/node'import 'dotenv/config'import { createInterface } from 'node:readline/promises'const scalekit = new ScalekitClient(process.env.SCALEKIT_ENVIRONMENT_URL,process.env.SCALEKIT_CLIENT_ID,process.env.SCALEKIT_CLIENT_SECRET,)const actions = scalekit.actionsconst connector = 'swaggermcp'const identifier = 'user_123'// Generate an authorization link for the userconst { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })console.log('Authorize Swagger MCP:', link)const rl = createInterface({ input: process.stdin, output: process.stdout })await rl.question('Press Enter after authorizing...')rl.close()// Make your first callconst result = await actions.executeTool({connector,identifier,toolName: 'swaggermcp_swagger_list_organizations',toolInput: {},})console.log(result)Terminal window npx tsx quickstart.mtsquickstart.py import osfrom scalekit import ScalekitClientfrom dotenv import load_dotenvload_dotenv()scalekit_client = ScalekitClient(env_url=os.getenv("SCALEKIT_ENVIRONMENT_URL"),client_id=os.getenv("SCALEKIT_CLIENT_ID"),client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),)actions = scalekit_client.actionsconnection_name = "swaggermcp"identifier = "user_123"# Generate an authorization link for the userlink_response = actions.get_authorization_link(connection_name=connection_name,identifier=identifier,)print("Authorize Swagger MCP:", link_response.link)input("Press Enter after authorizing...")# Make your first callresult = actions.execute_tool(tool_input={},tool_name="swaggermcp_swagger_list_organizations",connection_name=connection_name,identifier=identifier,)print(result)Terminal window python quickstart.pyEach user signs in once. See Authorize a user for the full flow and statuses.
Tools
Pass the exact name toexecute_toolswaggermcp_swagger_get_api_definitionFetch resolved API definition from SwaggerHub Registry based on owner, API name, and version.Read-onlySwagger Get Api Definition
Fetch resolved API definition from SwaggerHub Registry based on owner, API name, and version. **Toolset:** Registry API **Parameters:** - owner (string) *required*: API owner (organization or user, case-sensitive) - api (string) *required*: API name (case-sensitive) - version (string) *required*: Version identifier - resolved (boolean): Set to true to get the resolved version with all external $refs included (default false) - flatten (boolean): Set to true to create models from inline schemas in OpenAPI definition (default false)
Inputs
apistringrequired- API name (case-sensitive)
ownerstringrequired- API owner (organization or user, case-sensitive)
versionstringrequired- Version identifier
flattenboolean- Set to true to create models from inline schemas in OpenAPI definition (default false)
formatstring- Response format: 'json' (default) may convert YAML to JSON; 'text' returns the definition as YAML â required for swagger_patch_api edits.one of
jsontext resolvedboolean- Set to true to get the resolved version with all external $refs included (default false)
swaggermcp_swagger_get_documentGet document content and metadata by document ID.Read-onlySwagger Get Document
Get document content and metadata by document ID. Useful for retrieving HTML or Markdown content from table of contents items. **Toolset:** Documents **Parameters:** - documentId (string) *required*: Document UUID - unique identifier for the document
Inputs
documentIdstringrequired- Document UUID - unique identifier for the document
swaggermcp_swagger_get_portalRetrieve information about a specific portal.Read-onlySwagger Get Portal
Retrieve information about a specific portal. **Toolset:** Portals **Parameters:** - portalId (string) *required*: Portal UUID or subdomain - unique identifier for the portal instance
Inputs
portalIdstringrequired- Portal UUID or subdomain - unique identifier for the portal instance
swaggermcp_swagger_get_portal_productRetrieve information about a specific product resource.Read-onlySwagger Get Portal Product
Retrieve information about a specific product resource. **Toolset:** Products **Parameters:** - productId (string) *required*: Product UUID or identifier in the format 'portal-subdomain:product-slug' - unique identifier for the product
Inputs
productIdstringrequired- Product UUID or identifier in the format 'portal-subdomain:product-slug' - unique identifier for the product
swaggermcp_swagger_list_organizationsGet organizations for a user.Read-onlySwagger List Organizations
Get organizations for a user. Returns a list of organizations that the authenticating user is a member of. On-Premise admin gets a list of all organizations in the system. **Toolset:** Registry API **Parameters:** - q (string): Search organizations by partial or full name (case-insensitive) - sortBy (enum): The property to sort the results by - order (enum): Sort order - page (number): 0-based index of the page to return - pageSize (number): Number of results per page to return
Inputs
orderstring- Sort orderone of
ASCDESC pagenumber- 0-based index of the page to return
pageSizenumber- Number of results per page to return
qstring- Search organizations by partial or full name (case-insensitive)
sortBystring- The property to sort the results byone of
NAMEEMAIL
swaggermcp_swagger_list_portal_product_sectionsGet sections for a specific product within a portal.Read-onlySwagger List Portal Product Sections
Get sections for a specific product within a portal. **Toolset:** Sections **Parameters:** - productId (string) *required*: Product UUID or identifier in the format 'portal-subdomain:product-slug' - unique identifier for the product - embed (array): List of related entities to embed in the response - e.g., ['tableOfContents', 'tableOfContents.swaggerhubApi'] to include table of contents and SwaggerHub API details - page (number): Page number for paginated results - specifies which page of results to retrieve (default is 1) - size (number): Number of items per page for pagination - controls how many results are returned per page (default is 10)
Inputs
productIdstringrequired- Product UUID or identifier in the format 'portal-subdomain:product-slug' - unique identifier for the product
embedarray- List of related entities to embed in the response - e.g., ['tableOfContents', 'tableOfContents.swaggerhubApi'] to include table of contents and SwaggerHub API details
pagenumber- Page number for paginated results - specifies which page of results to retrieve (default is 1)
sizenumber- Number of items per page for pagination - controls how many results are returned per page (default is 20)
swaggermcp_swagger_list_portal_productsGet products for a specific portal that match your criteria.Read-onlySwagger List Portal Products
Get products for a specific portal that match your criteria. **Toolset:** Products **Parameters:** - portalId (string) *required*: Portal UUID or subdomain - unique identifier for the portal instance
Inputs
portalIdstringrequired- Portal UUID or subdomain - unique identifier for the portal instance
swaggermcp_swagger_list_portalsSearch for available portals within Swagger.Read-onlySwagger List Portals
Search for available portals within Swagger. Only portals where you have at least a designer role, either at the product level or organization level, are returned. **Toolset:** Portals
Inputs
This tool takes no inputs.
swaggermcp_swagger_list_table_of_contentsGet table of contents for a section of a product within a portal.Read-onlySwagger List Table Of Contents
Get table of contents for a section of a product within a portal. **Toolset:** Table Of Contents **Parameters:** - sectionId (string) *required*: Section ID - unique identifier for the section within the product - embed (array): List of related entities to embed in the response - e.g., ['swaggerhubApi'] to include SwaggerHub API details - page (number): Page number for paginated results - specifies which page of results to retrieve (default is 1) - size (number): Number of items per page for pagination - controls how many results are returned per page (default is 20)
Inputs
sectionIdstringrequired- Section ID - unique identifier for the section within the product
embedarray- List of related entities to embed in the response - e.g., ['swaggerhubApi'] to include SwaggerHub API details
pagenumber- Page number for paginated results - specifies which page of results to retrieve (default is 1)
sizenumber- Number of items per page for pagination - controls how many results are returned per page (default is 20)
swaggermcp_swagger_scan_api_standardizationRun a standardization scan against an API definition using the organization's governance and standardization rules.Read-onlySwagger Scan Api Standardization
Run a standardization scan against an API definition using the organization's governance and standardization rules. Accepts a raw YAML or JSON OpenAPI/AsyncAPI definition and returns a list of validation errors, the total issue count, and counts grouped by severity. Use this tool when the user provides the API definition content directly (as raw YAML or JSON) and asks to validate, scan, or check the governance or standardization of the API. **Toolset:** Registry API **Parameters:** - orgName (string) *required*: The organization name to use for standardization rules - definition (string) *required*: API definition content (OpenAPI/AsyncAPI specification in JSON or YAML format) to scan for standardization errors
Inputs
definitionstringrequired- API definition content (OpenAPI/AsyncAPI specification in JSON or YAML format) to scan for standardization errors
orgNamestringrequired- The organization name to use for standardization rules
swaggermcp_swagger_scan_api_standardization_from_registryRun a standardization scan on an API that already exists in SwaggerHub Registry, identified by organization name, API name, and version.Read-onlySwagger: Scan API Standardization from Registry
Run a standardization scan on an API that already exists in SwaggerHub Registry, identified by organization name, API name, and version. Fetches the API definition from the registry internally and scans it against the organization's governance and standardization rules. Returns a list of validation errors, total issue count, counts grouped by severity, and a SwaggerHub UI URL for the scanned API. Use this tool when the user identifies the API by org name, API name, and version and asks to validate, scan, or check the governance or standardization of an existing API. **Toolset:** Registry API **Parameters:** - orgName (string) *required*: The organization name that owns the API and provides the standardization rules (case-sensitive) - apiName (string) *required*: API name (case-sensitive) - version (string) *required*: Version identifier
Inputs
apiNamestringrequired- API name (case-sensitive)
orgNamestringrequired- The organization name that owns the API and provides the standardization rules (case-sensitive)
versionstringrequired- Version identifier
swaggermcp_swagger_search_apis_and_domainsSearch for APIs and Domains in SwaggerHub Registry using the comprehensive /specs endpoint and retrieve metadata including owner, name, description, summary, version, and specification.Read-onlySwagger Search Apis And Domains
Search for APIs and Domains in SwaggerHub Registry using the comprehensive /specs endpoint and retrieve metadata including owner, name, description, summary, version, and specification. **Toolset:** Registry API **Parameters:** - query (string): Search query to filter APIs by name, description, or content - state (enum): Filter APIs by publication state - ALL (default), PUBLISHED, or UNPUBLISHED - tag (string): Filter APIs by tag - offset (number): Offset for pagination (0-based, default 0) - limit (number): Number of results per page (1-100, default 20) - sort (enum): Sort field - NAME, UPDATED, or CREATED (default NAME) - order (enum): Sort order - ASC or DESC (default ASC) - owner (string): Filter APIs by owner (organization or user) - specType (enum): Filter by specification type - API or DOMAIN (default all types)
Inputs
limitnumber- Number of results per page (1-100, default 20)
offsetnumber- Offset for pagination (0-based, default 0)
orderstring- Sort order - ASC or DESC (default ASC)one of
ASCDESC ownerstring- Filter APIs by owner (organization or user)
querystring- Search query to filter APIs by name, description, or content
sortstring- Sort field - NAME, UPDATED, or CREATED (default NAME)one of
NAMEUPDATEDCREATED specTypestring- Filter by specification type - API or DOMAIN (default all types)one of
APIDOMAIN statestring- Filter APIs by publication state - ALL (default), PUBLISHED, or UNPUBLISHEDone of
ALLPUBLISHEDUNPUBLISHED tagstring- Filter APIs by tag
swaggermcp_swagger_create_documentation_pageCreate a documentation page in a portal product in a single tool call.WriteSwagger: Create Documentation Page
Create a documentation page in a portal product in a single tool call. Supports markdown and html content types. Returns the page location details (productId, sectionId, slug) and a draftUrl to edit it in the portal. **Toolset:** Documents **Parameters:** - portalId (string) *required*: Portal UUID or subdomain - unique identifier for the portal - productId (string) *required*: Product UUID - unique identifier for the product - pageTitle (string) *required*: Title of the documentation page - will be displayed in navigation (3-255 characters) - pageSlug (string): URL slug for the documentation page. 3-255 characters, lowercase, alphanumeric with hyphens, underscores, or dots (e.g. 'my-page'). If not provided, the slug is generated from the page title. - pageContent (string): Content of the documentation page. Provide HTML when contentType is 'html', Markdown when contentType is 'markdown'. - contentType (enum): Content type of the documentation page. 'markdown' works with both 'internal' and 'external' source. 'html' only works with 'external' source — html + internal is not supported by the API and will return an error. (default: "markdown") - source (enum): Where the document content is managed. 'internal': editable in both the portal UI and via API. 'external': editable via API only, not in the portal UI. Constraint: 'html' content type only supports 'external' source. (default: "internal") - order (number): Order position of the documentation page within its parent section or item (default: 0) - parentId (string): Parent table of contents item ID - null for top-level pages, or ID of parent item for nested structure
- Idempotent
Inputs
pageTitlestringrequired- Title of the documentation page - will be displayed in navigation (3-255 characters)
portalIdstringrequired- Portal UUID or subdomain - unique identifier for the portal
productIdstringrequired- Product UUID - unique identifier for the product
contentTypestring- Content type of the documentation page. 'markdown' works with both 'internal' and 'external' source. 'html' only works with 'external' source — html + internal is not supported by the API and will return an error.one of
markdownhtmldefaultmarkdown ordernumber- Order position of the documentation page within its parent section or itemdefault
0 pageContentstring- Content of the documentation page. Provide HTML when contentType is 'html', Markdown when contentType is 'markdown'.
pageSlugstring- URL slug for the documentation page. 3-255 characters, lowercase, alphanumeric with hyphens, underscores, or dots (e.g. 'my-page'). If not provided, the slug is generated from the page title.
parentIdstring- Parent table of contents item ID - null for top-level pages, or ID of parent item for nested structure
sourcestring- Where the document content is managed. 'internal': editable in both the portal UI and via API. 'external': editable via API only, not in the portal UI. Constraint: 'html' content type only supports 'external' source.one of
internalexternaldefaultinternal
swaggermcp_swagger_create_portalCreate a new portal within Swagger.WriteSwagger Create Portal
Create a new portal within Swagger. **Toolset:** Portals **Parameters:** - name (string): The display name for the portal - shown to users and in branding (3-40 characters) - subdomain (string) *required*: The portal subdomain - used in the portal URL (e.g., 'myportal' for myportal.example.com). Must be unique, lowercase, 3-20 characters, alphanumeric with hyphens - offline (boolean): If true, the portal will not be visible to customers - useful for development/staging environments. Defaults to false - routing (string): Routing strategy for the portal - either 'browser' (client-side routing) or 'proxy' (server-side routing). Defaults to 'browser' - credentialsEnabled (boolean): Whether authentication credentials are enabled for accessing the portal. When true, users can authenticate to access private content. Defaults to true - swaggerHubOrganizationId (string) *required*: The corresponding Swagger organization UUID - required for portal creation. This links the portal to your Swagger organization. Only one Portal per Swagger organization is allowed. - openapiRenderer (string): OpenAPI renderer type: 'SWAGGER_UI' (Swagger UI), 'ELEMENTS' (Stoplight Elements), or 'TOGGLE' (allows switching between both with Elements as default). Defaults to 'TOGGLE' - pageContentFormat (string): Format for page content rendering - determines how documentation pages are processed: 'HTML', 'MARKDOWN', or 'BOTH'. Defaults to 'HTML'
- Idempotent
Inputs
subdomainstringrequired- The portal subdomain - used in the portal URL (e.g., 'myportal' for myportal.example.com). Must be unique, lowercase, 3-20 characters, alphanumeric with hyphens
swaggerHubOrganizationIdstringrequired- The corresponding SwaggerHub organization UUID - required for portal creation. This links the portal to your SwaggerHub organization
credentialsEnabledboolean- Whether authentication credentials are enabled for accessing the portal. When true, users can authenticate to access private content. Defaults to true
namestring- The display name for the portal - shown to users and in branding (3-40 characters)
offlineboolean- If true, the portal will not be visible to customers - useful for development/staging environments. Defaults to false
openapiRendererstring- OpenAPI renderer type: 'SWAGGER_UI' (Swagger UI), 'ELEMENTS' (Stoplight Elements), or 'TOGGLE' (allows switching between both with Elements as default). Defaults to 'TOGGLE'
pageContentFormatstring- Format for page content rendering - determines how documentation pages are processed: 'HTML', 'MARKDOWN', or 'BOTH'. Defaults to 'HTML'
routingstring- Routing strategy for the portal - either 'browser' (client-side routing) or 'proxy' (server-side routing). Defaults to 'browser'
swaggermcp_swagger_create_portal_productCreate a new product for a specific portal.WriteSwagger Create Portal Product
Create a new product for a specific portal. **Toolset:** Products **Parameters:** - portalId (string) *required*: Portal UUID or subdomain - unique identifier for the portal instance - type (string) *required*: Product creation type - 'new' to create from scratch or 'copy' to duplicate an existing product - productId (string): Source product UUID to copy from - required when type is 'copy', specifies which existing product to duplicate. Omit when type is 'new' - name (string) *required*: Product display name - will be shown to users in the portal navigation and product listings (3-40 characters) - slug (string) *required*: URL-friendly identifier for the product - must be unique within the portal, used in URLs (e.g., 'my-api' becomes /my-api). 3-22 characters, lowercase, alphanumeric with hyphens, underscores, or dots - description (string): Product description - explains what the API/product does, shown in product listings and cards (max 110 characters) - public (boolean): Whether the product is publicly visible to all portal visitors - false means only authenticated users with appropriate roles can access it - hidden (boolean): Whether the product is hidden from the portal landing page navigation menus - useful for internal or draft products
- Idempotent
Inputs
namestringrequired- Product display name - will be shown to users in the portal navigation and product listings (3-40 characters)
portalIdstringrequired- Portal UUID or subdomain - unique identifier for the portal instance
slugstringrequired- URL-friendly identifier for the product - must be unique within the portal, used in URLs (e.g., 'my-api' becomes /my-api). 3-22 characters, lowercase, alphanumeric with hyphens, underscores, or dots
typestringrequired- Product creation type - 'new' to create from scratch or 'copy' to duplicate an existing product
descriptionstring- Product description - explains what the API/product does, shown in product listings and cards (max 110 characters)
hiddenboolean- Whether the product is hidden from the portal landing page navigation menus - useful for internal or draft products
productIdstring- Source product UUID to copy from - required when type is 'copy', specifies which existing product to duplicate. Omit when type is 'new'
publicboolean- Whether the product is publicly visible to all portal visitors - false means only authenticated users with appropriate roles can access it
swaggermcp_swagger_create_table_of_contentsCreate a new table of contents item in a portal product section.WriteSwagger Create Table Of Contents
Create a new table of contents item in a portal product section. Supports API references, HTML content, and Markdown content types. **Toolset:** Table Of Contents **Parameters:** - sectionId (string) *required*: Section ID - unique identifier for the section within the product - type (enum) *required*: Type of table of contents creation - 'new' to create from scratch or 'copy' to duplicate an existing one - title (string) *required*: Title of the table of contents item - will be displayed in navigation (3-40 characters) - slug (string) *required*: URL-friendly identifier for the table of contents item - must be unique within the section (3-22 characters, lowercase, alphanumeric with hyphens/underscores/dots) - order (number) *required*: Order position of the table of contents item within its parent section or item - parentId (string): Parent table of contents item ID - null for top-level items, or ID of parent item for nested structure - content (object): Content configuration for the table of contents item
- Idempotent
Inputs
ordernumberrequired- Order position of the table of contents item within its parent section or item
sectionIdstringrequired- Section ID - unique identifier for the section within the product
slugstringrequired- URL-friendly identifier for the table of contents item - must be unique within the section (3-22 characters, lowercase, alphanumeric with hyphens/underscores/dots)
titlestringrequired- Title of the table of contents item - will be displayed in navigation (3-40 characters)
typestringrequired- Type of table of contents creation - 'new' to create from scratch or 'copy' to duplicate an existing oneone of
newcopy contentobject- Content configuration for the table of contents item
parentIdstring- Parent table of contents item ID - null for top-level items, or ID of parent item for nested structure
swaggermcp_swagger_patch_apiApply targeted search/replace edits to a YAML API definition in SwaggerHub Registry.WriteSwagger Patch Api
Apply targeted search/replace edits to a YAML API definition in SwaggerHub Registry. Only OpenAPI and AsyncAPI definitions are supported. Each edit's 'oldString' must be copied exactly from swagger_get_api_definition with format:'text' and without 'resolved' or 'flatten' â those options transform the definition, so edits based on them will not match the stored source. JSON definitions are not supported. Nothing is saved unless every edit applies â failed edits are returned with 'no_match' or 'ambiguous' status. When 'newVersion' is given the patched definition is saved as a new private version; patching in place keeps the visibility of the existing version. Use this tool to fix specific issues in an existing API without regenerating the whole definition. **Toolset:** Registry API **Parameters:** - owner (string) *required*: API owner (organization or user, case-sensitive) - apiName (string) *required*: API name (case-sensitive) - version (string) *required*: Version of the definition to patch (base version, e.g. '1.0.0') - newVersion (string): Version to save the patched definition as (e.g. '1.0.1'). Must not already exist and is always created as private. Omit to overwrite the base version, which keeps its current visibility. The definition's info.version is updated automatically â do not add an edit for it. - edits (array) *required*: Search/replace edits applied sequentially to the YAML definition. Nothing is saved unless every edit applies (atomic).
Inputs
apiNamestringrequired- API name (case-sensitive)
editsarrayrequired- Search/replace edits applied sequentially to the YAML definition. Nothing is saved unless every edit applies (atomic).
ownerstringrequired- API owner (organization or user, case-sensitive)
versionstringrequired- Version of the definition to patch (base version, e.g. '1.0.0')
newVersionstring- Version to save the patched definition as (e.g. '1.0.1'). Must not already exist and is always created as private. Omit to overwrite the base version, which keeps its current visibility. The definition's info.version is updated automatically â do not add an edit for it.
swaggermcp_swagger_resolve_organization_portalResolve portal details for a Swagger organization in a single step.WriteSwagger: Resolve Organization Portal
Resolve portal details for a Swagger organization in a single step. Given an organization UUID, returns the portal ID, subdomain, customDomain (when configured), and the list of products (with productId, productSlug, and productName) for the organization's portal. If the organization has no portal yet, a new portal is created automatically. Use this tool to obtain all portal context needed for subsequent portal and product operations. **Toolset:** Portals **Parameters:** - organizationId (string) *required*: Swagger organization UUID - the organization to resolve portal details for
- Idempotent
Inputs
organizationIdstringrequired- Swagger organization UUID - the organization to resolve portal details for
swaggermcp_swagger_validate_apiValidate an OpenAPI or AsyncAPI definition using server-side apidom-ls.WriteSwagger Validate Api
Validate an OpenAPI or AsyncAPI definition using server-side apidom-ls. Returns structured diagnostics with line number, severity, and message for each finding. Supports OpenAPI 2.0, 3.0, 3.1, and AsyncAPI. Provide either the raw definition (JSON or YAML) OR an existing API by owner, apiName, and version. Use this tool when the user asks to validate, lint, or check an API spec for structural errors matching the Studio Validation tab. **Toolset:** Registry API **Parameters:** - definition (string): API definition content (OpenAPI/AsyncAPI in JSON or YAML). Provide this or owner/apiName/version, not both. - owner (string): API owner (organization or user). Use with apiName and version to fetch an existing API from the registry. - apiName (string): API name - version (string): Version identifier - maxProblems (number): Cap on the number of findings returned (default 100, max 1000) - uri (string): Optional pseudo-URI hint for the parser (e.g. inmemory://spec.yaml)
Inputs
apiNamestring- API name
definitionstring- API definition content (OpenAPI/AsyncAPI in JSON or YAML). Provide this or owner/apiName/version, not both.
maxProblemsinteger- Cap on the number of findings returned (default 100, max 1000)
ownerstring- API owner (organization or user). Use with apiName and version to fetch an existing API from the registry.
uristring- Optional pseudo-URI hint for the parser (e.g. inmemory://spec.yaml)
versionstring- Version identifier
swaggermcp_swagger_create_api_from_promptGenerate and save an API definition based on a prompt using SmartBear AI.DestructiveSwagger Create Api From Prompt
Generate and save an API definition based on a prompt using SmartBear AI. This tool automatically applies organization governance and standardization rules during API generation. The specType parameter determines the format of the generated definition. Use: 'openapi20' for OpenAPI 2.0, 'openapi30x' for OpenAPI 3.0.x, 'openapi31x' for OpenAPI 3.1.x, 'asyncapi2xx' for AsyncAPI 2.x, 'asyncapi30x' for AsyncAPI 3.0.x. Use this tool when creating APIs that comply with governance policies or when generating APIs from natural language descriptions. Use this tool when users ask to create, generate, or design APIs with governance or standardization requirements. Returns HTTP 201 for creation, HTTP 200 for update. Response includes 'operation' field indicating whether it was a 'create' or 'update' operation along with API details and SwaggerHub URL. **Toolset:** Registry API **Parameters:** - owner (string) *required*: API owner (organization or user, case-sensitive) - apiName (string) *required*: API name - prompt (string) *required*: The prompt describing the desired API functionality (e.g., 'Create a RESTful API for managing a pet store with endpoints for pets, orders, and inventory') - specType (enum): Specification type for the generated API definition. Use: 'openapi20' for OpenAPI 2.0, 'openapi30x' for OpenAPI 3.0.x (default), 'openapi31x' for OpenAPI 3.1.x, 'asyncapi2xx' for AsyncAPI 2.x, 'asyncapi30x' for AsyncAPI 3.0.x (default: "openapi30x")
- Idempotent
Inputs
apiNamestringrequired- API name
ownerstringrequired- API owner (organization or user, case-sensitive)
promptstringrequired- The prompt describing the desired API functionality (e.g., 'Create a RESTful API for managing a pet store with endpoints for pets, orders, and inventory')
specTypestring- Specification type for the generated API definition. Use: 'openapi20' for OpenAPI 2.0, 'openapi30x' for OpenAPI 3.0.x (default), 'openapi31x' for OpenAPI 3.1.x, 'asyncapi2xx' for AsyncAPI 2.x, 'asyncapi30x' for AsyncAPI 3.0.xone of
openapi20openapi30xopenapi31xasyncapi2xxasyncapi30xdefaultopenapi30x
swaggermcp_swagger_create_or_update_apiCreate a new API or update an existing API in SwaggerHub Registry for Swagger Studio.DestructiveSwagger Create Or Update Api
Create a new API or update an existing API in SwaggerHub Registry for Swagger Studio. The API specification type (OpenAPI, AsyncAPI) is automatically detected from the definition content. APIs are always created with fixed values: version 1.0.0, private visibility, and automock disabled (these values cannot be changed). Returns HTTP 201 for creation, HTTP 200 for update. Response includes 'operation' field indicating whether it was a 'create' or 'update' operation along with API details and SwaggerHub URL. **Toolset:** Registry API **Parameters:** - owner (string) *required*: Organization name (owner of the API) - apiName (string) *required*: API name - definition (string) *required*: API definition content (OpenAPI/AsyncAPI specification in JSON or YAML format). Format is automatically detected. API is created with fixed values: version 1.0.0, private visibility, automock disabled, and no project assignment.
- Idempotent
Inputs
apiNamestringrequired- API name
definitionstringrequired- API definition content (OpenAPI/AsyncAPI specification in JSON or YAML format). Format is automatically detected. API is created with fixed values: version 1.0.0, private visibility, automock disabled, and no project assignment.
ownerstringrequired- Organization name (owner of the API)
swaggermcp_swagger_delete_portal_productDelete a product from a specific portal **Toolset:** Products **Parameters:** - productId (string) *required*: Product UUID or identifier in the format 'portal-subdomain:product-slug' - unique identifier for the productDestructiveSwagger Delete Portal Product
Delete a product from a specific portal **Toolset:** Products **Parameters:** - productId (string) *required*: Product UUID or identifier in the format 'portal-subdomain:product-slug' - unique identifier for the product
- Idempotent
Inputs
productIdstringrequired- Product UUID or identifier in the format 'portal-subdomain:product-slug' - unique identifier for the product
swaggermcp_swagger_delete_table_of_contentsDelete table of contents entry.DestructiveSwagger Delete Table Of Contents
Delete table of contents entry. Performs a soft-delete of an entry from the table of contents. Supports recursive deletion of nested items. **Toolset:** Table Of Contents **Parameters:** - tableOfContentsId (string) *required*: The table of contents UUID, or identifier in the format 'portal-subdomain:product-slug:section-slug:table-of-contents-slug' - recursive (boolean): Flag to include all the nested tables of contents (default: false)
- Idempotent
Inputs
tableOfContentsIdstringrequired- The table of contents UUID, or identifier in the format 'portal-subdomain:product-slug:section-slug:table-of-contents-slug'
recursiveboolean- Flag to include all the nested tables of contents (default: false)
swaggermcp_swagger_publish_portal_productPublish a product's content to make it live or as preview.DestructiveSwagger Publish Portal Product
Publish a product's content to make it live or as preview. This endpoint publishes the current content of a product, making it visible to portal visitors. Use preview mode to test before going live. Optionally provide `tableOfContentsId` to get a page-specific URL. Returns publication status, a live or preview URL (null if URL building fails), product and portal metadata, and an optional `warning` when metadata/URL building failed — a warning does NOT mean the publish failed. **Toolset:** Products **Parameters:** - productId (string) *required*: Product UUID or identifier in the format 'portal-subdomain:product-slug' - unique identifier for the product - tableOfContentsId (string): Optional table of contents UUID, or identifier in the format 'portal-subdomain:product-slug:section-slug:table-of-contents-slug'. When provided, publishPortalProduct uses it to resolve the published URL path for the returned preview/live link. - preview (boolean): Whether to publish as preview (true) or live (false). Preview allows testing before going live. Defaults to false (live publication) (default: false)
- Idempotent
Inputs
productIdstringrequired- Product UUID or identifier in the format 'portal-subdomain:product-slug' - unique identifier for the product
previewboolean- Whether to publish as preview (true) or live (false). Preview allows testing before going live. Defaults to false (live publication)default
false tableOfContentsIdstring- Optional table of contents UUID, or identifier in the format 'portal-subdomain:product-slug:section-slug:table-of-contents-slug'. When provided, publishPortalProduct uses it to resolve the published URL path for the returned preview/live link.
swaggermcp_swagger_standardize_apiStandardize and fix an API definition using AI to ensure compliance with governance policies.DestructiveSwagger Standardize Api
Standardize and fix an API definition using AI to ensure compliance with governance policies. Scans the API definition for standardization errors and automatically fixes them using SmartBear AI. Optionally provide 'newVersion' (e.g. patch bump '1.0.0' → '1.0.1') to save the fixed definition as a new version — omitting it will overwrite the current version. Returns the number of errors found and the fixed definition if successful. Use this tool when users ask to standardize, fix, govern, or ensure governance compliance of APIs. **Toolset:** Registry API **Parameters:** - owner (string) *required*: API owner (organization or user, case-sensitive) - api (string) *required*: API name (case-sensitive) - version (string) *required*: Version identifier - newVersion (string): The version to save the fixed definition as (e.g. '1.0.1'). Omitting this will overwrite the current version — prefer providing a patch bump (e.g. '1.0.0' → '1.0.1') unless the user specifies otherwise.
- Idempotent
Inputs
apistringrequired- API name (case-sensitive)
ownerstringrequired- API owner (organization or user, case-sensitive)
versionstringrequired- Version identifier
newVersionstring- The version to save the fixed definition as (e.g. '1.0.1'). Omitting this will overwrite the current version — prefer providing a patch bump (e.g. '1.0.0' → '1.0.1') unless the user specifies otherwise.
swaggermcp_swagger_update_documentUpdate the content or source of an existing document.DestructiveSwagger Update Document
Update the content or source of an existing document. Supports both HTML and Markdown content types. **Toolset:** Documents **Parameters:** - documentId (string) *required*: Document UUID - unique identifier for the document - content (string): The document content to update (HTML or Markdown based on document type) - type (enum): Content type of the document. Note: documents with type 'html' and source 'internal' cannot be edited via API — only 'html' + 'external' and all 'markdown' combinations are supported. - source (enum): Where the document content is managed. 'internal': editable in both portal UI and API. 'external': editable via API only. Note: 'html' + 'internal' documents cannot be updated via API.
- Idempotent
Inputs
documentIdstringrequired- Document UUID - unique identifier for the document
contentstring- The document content to update (HTML or Markdown based on document type)
sourcestring- Source of the document content - 'internal' allows to edit content in both UI and API, 'external' enables editing only via API.one of
internalexternal typestring- Content type - 'html' for HTML content or 'markdown' for Markdown contentone of
htmlmarkdown
swaggermcp_swagger_update_portalUpdate a specific portal's configuration.DestructiveSwagger Update Portal
Update a specific portal's configuration. **Toolset:** Portals **Parameters:** - portalId (string) *required*: Portal UUID or subdomain - unique identifier for the portal instance - name (string): Update the portal display name - shown to users and in branding (3-40 characters) - subdomain (string): Update the portal subdomain - changes the portal URL. Must remain unique across all portals (3-20 characters, lowercase, alphanumeric with hyphens) - customDomain (boolean): Enable/disable custom domain for the portal - allows using your own domain instead of the default subdomain - gtmKey (string): Google Tag Manager key for analytics tracking - format: GTM-XXXXXX (max 25 characters) - offline (boolean): Set portal visibility - true hides portal from customers (useful for maintenance or development) - routing (string): Update routing strategy - 'browser' for client-side routing or 'proxy' for server-side routing - credentialsEnabled (boolean): Enable/disable authentication credentials for portal access - controls whether users can authenticate to view private content - openapiRenderer (string): Change OpenAPI renderer: 'SWAGGER_UI' (Swagger UI), 'ELEMENTS' (Stoplight Elements), or 'TOGGLE' (switch between both) - pageContentFormat (string): Update page content format for documentation rendering: 'HTML', 'MARKDOWN', or 'BOTH'
- Idempotent
Inputs
portalIdstringrequired- Portal UUID or subdomain - unique identifier for the portal instance
credentialsEnabledboolean- Enable/disable authentication credentials for portal access - controls whether users can authenticate to view private content
customDomainboolean- Enable/disable custom domain for the portal - allows using your own domain instead of the default subdomain
gtmKeystring- Google Tag Manager key for analytics tracking - format: GTM-XXXXXX (max 25 characters)
namestring- Update the portal display name - shown to users and in branding (3-40 characters)
offlineboolean- Set portal visibility - true hides portal from customers (useful for maintenance or development)
openapiRendererstring- Change OpenAPI renderer: 'SWAGGER_UI' (Swagger UI), 'ELEMENTS' (Stoplight Elements), or 'TOGGLE' (switch between both)
pageContentFormatstring- Update page content format for documentation rendering: 'HTML', 'MARKDOWN', or 'BOTH'
routingstring- Update routing strategy - 'browser' for client-side routing or 'proxy' for server-side routing
subdomainstring- Update the portal subdomain - changes the portal URL. Must remain unique across all portals (3-20 characters, lowercase, alphanumeric with hyphens)
swaggermcp_swagger_update_portal_productUpdate a product's settings within a specific portal.DestructiveSwagger Update Portal Product
Update a product's settings within a specific portal. **Toolset:** Products **Parameters:** - productId (string) *required*: Product UUID or identifier in the format 'portal-subdomain:product-slug' - unique identifier for the product - name (string): Update product display name - changes how it appears to users in navigation and listings (3-40 characters) - slug (string): Update URL-friendly identifier - must remain unique within the portal, affects product URLs (3-22 characters, lowercase, alphanumeric with hyphens/underscores/dots) - description (string): Update product description - explains the API/product functionality, shown in listings (max 110 characters) - public (boolean): Change product visibility - true makes it publicly accessible to all visitors, false restricts to authenticated users with roles - hidden (boolean): Change navigation visibility - true hides from portal landing page menus while keeping the product accessible via direct links
- Idempotent
Inputs
productIdstringrequired- Product UUID or identifier in the format 'portal-subdomain:product-slug' - unique identifier for the product
descriptionstring- Update product description - explains the API/product functionality, shown in listings (max 110 characters)
hiddenboolean- Change navigation visibility - true hides from portal landing page menus while keeping the product accessible via direct links
namestring- Update product display name - changes how it appears to users in navigation and listings (3-40 characters)
publicboolean- Change product visibility - true makes it publicly accessible to all visitors, false restricts to authenticated users with roles
slugstring- Update URL-friendly identifier - must remain unique within the portal, affects product URLs (3-22 characters, lowercase, alphanumeric with hyphens/underscores/dots)
No tools match.
