# Stoplight MCP for AI Agents AI Agent Connect

> Stoplight lets you link your AI agent directly to your API documentation and design workflows. Instead of flipping between tabs, your agent can navigate your Stoplight workspace to find schemas, check project status, and audit documentation. It turns your conversational assistant into a first-class citizen for your API lifecycle management.

## Overview
- **Category:** developer-tools
- **Price:** Free
- **Endpoint:** https://edge.vinkius.com/vk_preview_aafvDKV5H0XnKaJJQxGGJwn6mIM7hALMzWdPNAou/ai-agent-connect
- **Tags:** openapi, api-design, documentation, api-governance, schema-management, technical-writing

## Description

Imagine you're deep in a technical review and need to know exactly how a specific endpoint handles a payload. Usually, that means digging through a massive documentation portal or hunting for a specific schema file in a repository. With this Connector, you just ask your agent to find it for you. It navigates your workspace, pulls the right details, and summarizes them right in your chat window. It's about removing the friction of context switching. Whether you're trying to see who owns a project, audit recent changes in a workspace, or grab the raw text of a specific model, the agent handles the navigation. You get to stay in your flow while the agent does the heavy lifting of searching through your organized API assets. If you're managing a complex ecosystem of services, this connection makes your documentation actually usable in real-time. You can find this in the Vinkius catalog to get your team up and running quickly. It bridges the gap between your static docs and your active development cycle, making sure your AI actually knows what your APIs are capable of doing.

## Tools

### get_node_details
Pull the raw details for a specific documentation node. Use this to get the exact schema or text for a specific endpoint.

### list_workspace_activity
View the latest logs for your workspace. Use this to see who changed what and when.

### list_workspace_members
See everyone who has access to a workspace. This is useful for auditing permissions and team roles.

### list_project_nodes
See every file, endpoint, and model in a project. This is great for mapping out a large API's structure.

### list_workspaces
See all workspaces you have access to. This helps you manage multiple organizational containers.

### list_projects
List all projects in a workspace. Use this to quickly navigate between different API products.

### get_project_details
Get the full metadata for a specific project. This helps you see the high-level status and description of an API repository.

## Prompt Examples

**Prompt:** 
```
What projects do we have in our production workspace?
```

**Response:** 
```
I've checked your Stoplight workspace. Here are the current projects:

| Project Name | Description |
| :--- | :--- |
| **Payment Gateway** | Handles all customer transactions and refunds. |
| **User Auth** | Manages login, registration, and JWT issuance. |
| **Data Analytics** | Internal tools for reporting and metrics. |
```

**Prompt:** 
```
Can you show me the schema for the login endpoint in the User Auth project?
```

**Response:** 
```
I've retrieved the documentation for the `login` endpoint. Here is the schema:

**Endpoint:** `POST /auth/login`
**Payload:**
- `username`: string (required)
- `password`: string (required)
- `mfa_token`: string (optional)

**Success Response:**
- `token`: string
- `expires_in`: integer
```

**Prompt:** 
```
Who are the admins for our core API?
```

**Response:** 
```
I've checked the workspace members for you. Here are the individuals with administrative privileges:

- **Jane Doe** (Admin)
- **John Smith** (Admin)
- **Alex Dev** (Editor)
```

## Capabilities

### Browse available workspaces
The agent can see all the organizational containers you have access to.

### View recent activity logs
You can see who made changes to your documentation and when they did it.

### Audit project metadata
The agent pulls high-level details for specific API projects in your workspace.

### Map project structures
You can see every file, endpoint, and model within a specific project.

### Extract raw node details
The agent pulls the specific text or schema for a documentation node.

### Identify workspace members
You can check who has access to your workspace and what roles they hold.

## Use Cases

### Checking a schema
An engineer asks the agent for the processing endpoint schema. The agent uses get_node_details to pull the JSON and explains the required fields.

### Permission Audit
A manager asks who is editing the core billing API. The agent uses list_workspace_members to provide a list of active contributors.

### Project Discovery
A new developer asks what projects exist in the workspace. The agent uses list_projects to show the full catalog of available APIs.

### Activity Summary
A technical writer asks for recent changes to the auth project. The agent uses list_workspace_activity to summarize the last 10 updates.

## Benefits

- Stop context switching by using list_workspaces to jump between different API environments without opening a browser.
- Stay updated on team changes by pulling recent logs with list_workspace_activity directly into your chat.
- Audit project ownership quickly using list_workspace_members to see who has admin or editor rights.
- Access specific endpoint schemas instantly with get_node_details to verify payload requirements.
- Map out complex API structures in seconds by listing all nodes with list_project_nodes.
- Review project metadata using get_project_details to ensure all documentation follows company standards.

## How It Works

The bottom line is that your API documentation becomes a searchable, actionable knowledge base for your AI agent.

1. Install the Connector and provide your STOPLIGHT_WORKSPACE slug and a valid STOPLIGHT_TOKEN.
2. Connect the Connector to your preferred AI client like Claude, Cursor, or Windsurf.
3. Ask your agent to find specific endpoints, list projects, or summarize recent workspace activity.

## Frequently Asked Questions

**Can the Stoplight MCP help me find specific API endpoints?**
Yes, it can query your project nodes to find specific endpoints, models, and files within your documentation.

**How does the Stoplight MCP handle multiple workspaces?**
It can list all the workspaces you have access to, allowing your agent to navigate between different organizational containers.

**Can my agent use Stoplight MCP to see who updated the docs?**
Yes, it pulls the recent activity logs for your workspace so you can see who made changes and when.

**Does the Stoplight MCP support OpenAPI schemas?**
Yes, it retrieves the raw text and specific details for your documentation nodes, which include OpenAPI models and schemas.

**Is the Stoplight MCP good for auditing team permissions?**
It's great for that. It can list all members of a workspace, showing you who has access and what roles they hold.

**Can I use the Stoplight MCP to get raw JSON for a specific API?**
Yes, by requesting details for a specific node, the agent can pull the raw text and schema information directly.

**Is the integration read-only?**
Yes. All tools only read from your Stoplight workspace — projects, nodes, schemas, and activity logs. No modifications or deletions are possible through this integration.

**What is the workspace slug?**
It's the subdomain of your Stoplight URL. For example, if your workspace is at `https://acme.stoplight.io`, the slug is `acme`. You can find it in the address bar when logged in.

**What data can the agent access?**
Projects, workspace members, activity logs, and all project nodes (endpoints, models, articles). Each node's full content — including OpenAPI schemas — can be retrieved via `get_node_details`.