Resources · Claude connector

Claude Swagger connectorWhat Claude can do in your Swagger account.

The Claude Swagger connector exposes 22 tools, 10 in read and 12 in write. Claude searches your API registry, scans definitions against your organisation's rules, generates or fixes APIs, and creates, edits, publishes or deletes portal products and pages.

Verified Trustpilot reviews · AI, automation & growth agency

Overview

What changes when Claude can work in Swagger

Swagger's directory caption sums it up: design, govern and document APIs. With the connector, you describe the job to Claude: it finds the API, runs the standardisation scan, proposes or applies fixes, and updates the documentation pages of your portal, all under your SmartBear login and roles.

Checking an API against house rules. Claude locates it with search_apis_and_domains, pulls the resolved definition through get_api_definition, and scan_api_standardization lists the violations by severity.

Fixing or drafting APIs. standardize_api corrects a non-compliant definition with SmartBear AI, ideally into a new version, and create_api_from_prompt generates a new API from a description with governance rules applied.

Running a developer portal. Claude can add a product with create_portal_product, edit a page through update_document, then preview or go live with publish_portal_product.

What it will not do: it only sees portals where you hold at least a designer role, and no source describes a confirmation of its own before the twelve writing tools. Nothing runs on a schedule either: Claude acts only while it answers you. The Claude connectors hub lists other developer connectors, and the Integrations page covers automation platforms.

Vocabulary

Five words before you connect

The Claude vocabulary behind this connector, in one minute.

Connector
The link you set up once between Claude and an account you already have, so Claude can work in it while it answers you.
Tool
One named thing the connector lets Claude do on that account. Claude picks the ones it needs, and the directory sheet lists them by name.
Authorization
The SmartBear sign-in screen where you give Claude the access it will use from then on. Granted once per person, and it can be revoked.
Approval
The confirmation Claude waits for before it goes ahead with something that changes an account, shown in the chat when it matters.
MCP
The shared standard behind connectors: it is what lets an assistant such as Claude talk to an outside service like Swagger.
Connect

Connecting Swagger to Claude in three steps

  1. 01

    Find Swagger in Claude

    Open Claude's settings, go to Customize then Connectors, and search for Swagger. On a Team or Enterprise workspace, an Owner or Primary Owner enables the connector first so members can then sign in one by one.

  2. 02

    Start the connection

    Click Connect on its row. SmartBear says a browser window opens for a SmartBear OAuth login, with no API token or environment variable to set. If the connection breaks later, use Disconnect and connect again.

  3. 03

    Read the authorization screen

    Look at the authorization screen before you accept. It belongs to SmartBear, not to Claude, and it decides what the access covers. You can also remove that access later from your SmartBear account.

Tools

The 22 Swagger tools, sorted by what they do

Swagger gives Claude 22 tools: 10 that read your account, 12 that change something in it.

SmartBear's own server code describes every one of them, with a read-only or modifying flag. Names stay as Claude shows them.

  • 10 read
  • 12 write

What Claude reads (10)

10 tools

Ten tools that search, open and scan APIs and portal content without altering them.

list_portals

Searches the developer portals available to you in Swagger, returning only those where you hold at least a designer role, at product or organisation level.

When it helps
you want to see which portals your role lets you work on.
Watch out
a portal missing here may simply sit outside your role.

Sourcegithub.com · September 30, 2026 ↗

get_portal

Retrieves the details of one portal, identified by its UUID or subdomain, so Claude knows how it is configured before touching anything inside.

When it helps
you want to check a portal's current settings, such as whether it is offline, without opening the Swagger interface.

Sourcegithub.com · September 30, 2026 ↗

list_portal_products

Returns the products of one portal that match your criteria, each of them grouping API documentation for visitors, and lists them so Claude can work through them one at a time.

When it helps
you want the full list of a portal's products before working on one of them.

Sourcegithub.com · September 30, 2026 ↗

get_portal_product

Opens one product, found by its UUID or by the portal subdomain and product slug, and returns its settings and metadata.

When it helps
you want to confirm whether a product is public or restricted to authenticated users before sharing its link.

Sourcegithub.com · September 30, 2026 ↗

list_portal_product_sections

Lists the sections inside a portal product, page by page, optionally with their tables of contents embedded, so Claude can map how the docs are organised.

When it helps
you want the outline of a product's documentation before reorganising it.

Sourcegithub.com · September 30, 2026 ↗

list_table_of_contents

Returns the table of contents of one section, page by page, and can embed the linked SwaggerHub API so Claude sees which reference sits where.

When it helps
you want to locate the page that documents a given topic within a section.

Sourcegithub.com · September 30, 2026 ↗

get_document

Fetches the content and metadata of a document by its ID, typically the HTML or Markdown behind a table of contents entry.

When it helps
you want to read the current wording of a portal page, HTML or Markdown, without leaving the conversation.

Sourcegithub.com · September 30, 2026 ↗

search_apis_and_domains

Searches the SwaggerHub registry for APIs and domains by text, owner, tag, publication state or type, and returns their name, owner, version and summary.

When it helps
you want every unpublished API owned by your organisation, with its version and summary.

Sourcegithub.com · September 30, 2026 ↗

get_api_definition

Fetches the resolved definition of one API version from the registry, as JSON by default or as the original YAML text on request.

When it helps
you want one version of an API explained in plain words from its actual definition.

Sourcegithub.com · September 30, 2026 ↗

scan_api_standardization

Checks a raw YAML or JSON definition against your organisation's governance and standardisation rules, and returns the issues found, grouped by severity, with a total count.

When it helps
validating a spec pasted into the conversation before it reaches the registry.

Sourcegithub.com · September 30, 2026 ↗

What Claude can create, change or delete (12)

12 tools

Twelve tools that build portals, products and pages, publish them, or generate and fix APIs. No source describes a confirmation of their own: the general rule below applies.

create_portal

Approval: see the rule

Sets up a new Swagger portal linked to your organisation, with a subdomain, a display name, a renderer choice and whether it starts offline or requires credentials.

What Claude asks for
no source describes a confirmation for this tool; the general approval rule below applies.
When it helps
your organisation has no portal yet and you want one set up from the conversation.
Watch out
SmartBear allows a single portal per Swagger organisation.

Sourcegithub.com · September 30, 2026 ↗

update_portal

Approval: see the rule

Edits a portal's configuration: display name, subdomain and therefore URL, custom domain, analytics key, visibility, routing, credentials and renderer.

What Claude asks for
nothing tool-specific is documented; the default rule holds.
When it helps
you need to take the portal offline or change its display name.
Watch out
SmartBear flags this tool as destructive; a new subdomain moves every portal link.

Sourcegithub.com · September 30, 2026 ↗

create_portal_product

Approval: see the rule

Adds a product to a portal, either from scratch or as a copy of an existing one, with name, slug, description, and public or hidden settings.

What Claude asks for
SmartBear documents no specific confirmation; rely on the general rule.
When it helps
you want a new product based on a copy of an existing one.
Watch out
the slug must be unique within the portal.

Sourcegithub.com · September 30, 2026 ↗

update_portal_product

Approval: see the rule

Changes a product's name, slug, description, public visibility or presence in the portal navigation menus.

What Claude asks for
no confirmation of its own is documented; the default rule applies.
When it helps
hiding a deprecated product from menus while keeping its pages reachable.
Watch out
a new slug changes the product's URL.

Sourcegithub.com · September 30, 2026 ↗

delete_portal_product

Approval: see the rule

Removes a product from a portal, which SmartBear's own code marks as a destructive operation.

What Claude asks for
no source describes a tool-specific confirmation; the general approval rule is what covers it.
When it helps
a product's documentation should no longer be on the portal.

Sourcegithub.com · September 30, 2026 ↗

publish_portal_product

Approval: see the rule

Publishes a product's current content, either as a preview for testing or live for portal visitors, and returns the resulting URL and publication status.

What Claude asks for
nothing specific is documented; the default rule applies.
When it helps
you want a preview link to check before the product goes live.
Watch out
a warning in the reply does not mean the publish failed, SmartBear notes.

Sourcegithub.com · September 30, 2026 ↗

create_table_of_contents

Approval: see the rule

Adds an entry to the table of contents of a product section, pointing to an API reference, an HTML page or a Markdown page.

What Claude asks for
SmartBear describes no confirmation of its own; the general rule applies.
When it helps
you want a new Markdown or HTML page, or an API reference, added to a section.

Sourcegithub.com · September 30, 2026 ↗

delete_table_of_contents

Approval: see the rule

Soft-deletes an entry from a table of contents and can do so recursively for nested items below it.

What Claude asks for
no tool-specific confirmation is documented; the default rule holds.
When it helps
pruning an outdated tutorial and its sub-pages.
Watch out
a recursive delete takes every nested page with it.

Sourcegithub.com · September 30, 2026 ↗

update_document

Approval: see the rule

Rewrites the content or the source setting of an existing portal document, in HTML or Markdown.

What Claude asks for
SmartBear documents nothing specific; the general approval rule applies.
When it helps
a portal page needs its text corrected in HTML or Markdown.
Watch out
SmartBear lists restrictions on which document types and sources can be edited.

Sourcegithub.com · September 30, 2026 ↗

create_or_update_api

Approval: see the rule

Creates a new API in the SwaggerHub registry or overwrites an existing one from a definition you supply, detecting OpenAPI or AsyncAPI automatically.

What Claude asks for
no source describes a confirmation of its own; the default rule applies.
When it helps
pushing a spec drafted in the chat into the registry.
Watch out
new APIs start at version 1.0.0, private, with mocking off, and those values are fixed.

Sourcegithub.com · September 30, 2026 ↗

create_api_from_prompt

Approval: see the rule

Generates and saves a new API, or a new version of one, from a natural-language description using SmartBear AI, applying your organisation's governance rules along the way.

What Claude asks for
nothing tool-specific is documented; rely on the general rule.
When it helps
you want a first OpenAPI 3.1 draft generated from a description.
Watch out
it fails if that API version already exists.

Sourcegithub.com · September 30, 2026 ↗

standardize_api

Approval: see the rule

Scans an API in the registry for standardisation errors and fixes them automatically with SmartBear AI, returning the error count and the corrected definition.

What Claude asks for
SmartBear documents no confirmation for this tool; the general approval rule applies.
When it helps
an existing API fails your governance rules and you want it corrected.
Watch out
without a new version number, it overwrites the current version.

Sourcegithub.com · September 30, 2026 ↗

Approvals

What Claude asks before acting

By default, Claude stops and asks for your go-ahead before any action it takes on an account in your place. With twelve tools that write, several of which SmartBear flags as destructive, that default deserves to stay on.

On Team and Enterprise workspaces, owners decide whether a member may let some actions through without being asked again, and they can bound what a connector may do for the whole organisation, keeping reads and closing writes for instance. Nobody bypasses that from their own account. Claude also works with your Swagger rights only: SmartBear's own portal listing returns just the portals where you hold at least a designer role, so what your login cannot reach stays out of the conversation.

Plans

Which plans include it

None of the 819 sheets in the official directory displays availability by plan. Connector by connector, the answer is published nowhere: it is a real gap in the catalogue.

What is published is the general rule: remote connectors are open to all users on Claude, Cowork, Claude Desktop and mobile. On Team and Enterprise, an Owner or Primary Owner enables the connector for the organisation before each member signs in. For the current state of this one, check its sheet in the official directory. Note that only SmartBear documents it; no Claude help article covers it.

Limits

Where the Claude Swagger connector stops

A connector is not an automation. Claude calls these tools while it answers you: no scan runs when someone pushes a new API version.

The tool list is an observed floor, not a promise: an administrator can open actions that no public sheet shows. The partner badge in the directory is not a security audit, and Anthropic says on every sheet that it does not choose the tools a publisher exposes and cannot guarantee they behave as announced. Connect only what comes from a publisher you trust, here SmartBear, whose server code is the source describing these tools.

Need help

Need help connecting Swagger to Claude?

A person reads every message.

FAQ

Questions about the Claude Swagger connector

01What can Claude do with the Swagger connector?
Claude can work on your APIs and developer portals in Swagger from a conversation. Ten tools read: they list and open portals, products, sections, tables of contents and documents, search the registry, fetch API definitions and scan a definition against your governance rules. Twelve tools write: they create and edit portals, products and pages, publish or delete them, create or overwrite APIs, generate one from a prompt and fix one automatically with SmartBear AI.
02Can Claude change or delete things in Swagger?
Yes, twelve of the 22 tools write. They create and edit portals and products, publish products as preview or live, add or remove table of contents entries, rewrite documents, create or overwrite APIs in the registry, generate APIs from a description and standardise existing ones. SmartBear's code flags deletions, publishing, updates and standardisation as destructive, and the standardisation tool overwrites the current version when no new version number is given to it.
03Does Claude ask before changing something in Swagger?
By default, Claude asks for confirmation before any action it takes on an account in your place. No source describes a confirmation specific to the Swagger write tools, so that default rule applies to all twelve. In an organisation workspace, owners decide whether members may let some actions through without a new prompt, and they can restrict what the connector may do for everyone, for example by keeping registry searches open and closing every write.
04Which Claude plans include the Swagger connector?
No official source publishes plan availability connector by connector, and none of the 819 directory sheets shows it. The general rule says remote connectors are open to all users on Claude, Cowork, Claude Desktop and mobile, with an Owner or Primary Owner enabling them first on Team and Enterprise. SmartBear's own documentation names no Claude plan at all. Only the connector's sheet in the directory shows its current state for your account.
05Does Claude see every portal and API in our Swagger organisation?
No, Claude works with your rights and nothing more. SmartBear's portal listing returns only portals where you hold at least a designer role, at product or organisation level, and registry actions follow the permissions of your SmartBear account. A portal or API your login cannot reach stays out of the answers. An owner of your Claude workspace can also restrict what the connector is allowed to do for the organisation.
06Will standardising an API in Claude overwrite my current version?
It can. SmartBear's description of the standardisation tool says you may pass a new version number, such as a patch bump, to save the fixed definition as a new version, and that leaving it out overwrites the current one. Asking Claude to create a new version keeps the original intact for comparison. The tool returns the number of errors found, the fixed definition and a link to view the result in Swagger.
07Claude or an automation tool for Swagger?
They do different jobs, so it depends on the use. Claude with this connector suits work you steer in the moment: reviewing an API, fixing governance issues, rewriting a portal page and publishing a preview. An automation platform or a CI pipeline runs checks on a schedule or on each change without anyone asking. This site has no n8n, Make or Zapier page for Swagger, so the Claude connector is the route described here.