Stoplight MCP connector

Stoplight is an API design, documentation, and governance platform that helps teams build and maintain API specifications and reference materials. The Stoplight MCP connector allows AI agents to publish API documentation anonymously or with authentication, export and import API projects, and control publication status. It also supports managing API lifecycle states and coordinating design assets across development teams.

Authentication type

• API Key - Requires a static API key to be configured before the agent can connect to the service.

Uses

Use the Stoplight MCP connector to perform the following actions:

• Maintain comprehensive API documentation that stays synchronized with your service definitions
• Control which API versions are live and accessible to development teams and partners
• Transfer API designs between Stoplight instances and external repositories for backup and collaboration
• Establish governance standards and design rules across all APIs in your organization
• Share API specifications publicly without requiring authentication or account credentials
• Archive and retire outdated API versions while preserving historical records
• Standardize API design practices across teams by enforcing consistent patterns and naming conventions

Example prompts

Use the following example prompts to invoke Stoplight MCP connector tools from your AI assistant or Boomi Connect workflow:

• Publish our customer API to Stoplight so the team can access the latest documentation.
• Export the payment processing API design from Stoplight to share with external partners.
• Import the authentication API from our repository into Stoplight to consolidate all designs.
• Make our public API specification available in Stoplight without requiring users to log in.
• Unpublish the deprecated version 1.0 API from Stoplight since we migrated to version 2.0.
• Show me all published APIs in Stoplight and their current documentation status.
• Create a public link in Stoplight for our partners to view the integration API.
• Back up all API designs from Stoplight by exporting them to our internal repository.
• Publish an update to the existing API documentation in Stoplight for the product team.
• Remove the beta API from public access in Stoplight before launching the stable release.

Stoplight MCP connector tools

The Stoplight MCP connector provides the following tools. Each tool maps to a specific action you can invoke from your AI agent or automation.

Tool	Description
POST_versions-publish-anon	Publishes a version as anonymous without requiring authentication.
GET_versions-versionId-export-format	Exports a specific version in the requested format.
PUT_versions-versionId-import	Imports content into a specific version.
POST_versions-versionId-publish	Publishes a specific version to make it available.
PUT_versions-versionId-unpublish	Removes a published version from public availability.