> ## Documentation Index
> Fetch the complete documentation index at: https://docs.onyx.app/llms.txt
> Use this file to discover all available pages before exploring further.

# Plugins

> Use MCP servers, OpenAPI plugins, and Craft Apps to work with live data and take actions

Plugins connect Onyx agents to the tools that your team uses. With a plugin, an agent can read live data,
such as a Linear issue, or take an action, such as post a Slack reply.

Your admin adds plugins for the workspace. You connect your account and choose where to use each plugin.

> [!NOTE]
>
> In Onyx 5.0, MCP and OpenAPI actions became plugins. Find them in **Plugins** in the sidebar,
> and in Chat under **Actions → Plugins**. Craft Apps moved from **Craft → Apps** to **Plugins** in the Craft sidebar.

![The Plugins page with an MCP server and a Slack Craft App](https://mintcdn.com/danswer/hJsHZLcvDzrFyha8/assets/overview/core_features/plugins/member_plugins_directory.png?fit=max\&auto=format\&n=hJsHZLcvDzrFyha8\&q=85\&s=8ef735144749d3cdc2cf5851efe7e77b)

## Plugin types

| Type | What it does | Where you can use it |
| - | - | - |
| **MCP** | Connects to a [Model Context Protocol](https://modelcontextprotocol.io/) server, such as Linear, Notion, or Atlassian | Chat, custom agents, and Craft |
| **OpenAPI** | Calls a REST API that your admin describes with an OpenAPI schema | Chat and custom agents |
| **Craft App** | Lets Craft act as you in Slack, Gmail, Google Calendar, Google Drive, Notion, Linear, GitHub, HubSpot, or Zendesk | Craft only |

For Craft Apps, see [Craft Apps](/overview/core_features/craft_apps).

### Plugins and Onyx knowledge

Plugins and [connectors](/overview/core_features/connectors) give agents different access.

* **Onyx knowledge** is an index of company documents. Onyx applies the source permissions,
  so you find only documents that you can access. Search is read only.
* **Plugins** call the external service live. When you connect your own account, the service applies your permissions.
  The plugin can read only what your account can read,
  and it can change content only if your account and your admin allow it.

## Connect a plugin

Select **Plugins** in the Chat sidebar or the Craft sidebar.

Use the **All**, **Connected**, and **Needs sign-in** filters, or search by name.
The status icon on each plugin shows where you can use it: **Main Chat**, **Custom agents**, and **Craft**.

**1. Open the plugin**

Click a plugin to open its details.

**2. Connect your account**

The **Connection** tab shows what the plugin needs:

| Status | What to do |
| - | - |
| **Ready to use** | Nothing. The plugin does not need an account. |
| **Workspace connection** | Nothing. Your workspace provides the connection. |
| **Uses your sign-in** | Nothing. The plugin uses your Onyx sign-in. |
| **Connect your account** | Click **Connect**, then sign in with the service. |
| **Add your credentials** | Enter the values that your admin asks for, such as a personal API key. |
| **Workspace setup required** | Ask an admin to finish the plugin setup. |

Sign in with the account that the agent should use. The agent acts as that account.

**3. Choose where to use it**

Set your personal defaults:

| Setting | Effect |
| - | - |
| **Enable in default Chat** | Makes the plugin available in your chats without a custom agent. |
| **Enable in Craft** | Makes the plugin available in your Craft sessions and scheduled tasks. Your organization's tool permissions still apply. |

Click **Save**.

![Plugin details with Ready to use, Enable in default Chat, and Enable in Craft](https://mintcdn.com/danswer/hJsHZLcvDzrFyha8/assets/overview/core_features/plugins/member_plugin_mcp_detail.png?fit=max\&auto=format\&n=hJsHZLcvDzrFyha8\&q=85\&s=26bc82dcf56b862095657649ceefaff6)

If a setting says **Disabled by admin**, your admin turned off the plugin for that surface. You cannot turn it on.
Custom agents that use the plugin can still use it.

## Review tools

The **Tools** tab lists the tools that the plugin gives the agent. For MCP plugins in Craft,
**Approval settings** shows which tools run automatically, which ask for your approval, and which are disabled.

![The Tools tab for an MCP plugin with three tools](https://mintcdn.com/danswer/hJsHZLcvDzrFyha8/assets/overview/core_features/plugins/member_plugin_mcp_tools.png?fit=max\&auto=format\&n=hJsHZLcvDzrFyha8\&q=85\&s=445bf39aa77d8262f5ae2c4a11970623)

If your admin lets users manage approval settings, you can change the policy for tools that the admin did not disable.

## Use plugins in Chat

Click the actions button in the message bar, then select **Plugins**. Turn a plugin on or off for the current chat,
or click **Browse plugins** to open the Plugins page.

![The actions menu in Chat with the Plugins menu open](https://mintcdn.com/danswer/hJsHZLcvDzrFyha8/assets/overview/core_features/plugins/chat_actions_plugins_flyout.png?fit=max\&auto=format\&n=hJsHZLcvDzrFyha8\&q=85\&s=e59c8ddbb852271934166cdd849ca9d4)

The agent decides when to call a plugin tool. To guide it, name the plugin or the service in your message. For example:
"Use DeepWiki to explain how the `onyx-dot-app/onyx` repository handles authentication."

In Chat, the agent calls plugin tools without an approval prompt. Check the result in the service after a change.

> [!NOTE]
>
> Custom agents use the plugins that the agent builder selected. Your default Chat settings do not change them.
> See [Agents](/overview/core_features/agents).

## Disconnect a plugin

Open the plugin and click **Disconnect**. Onyx removes your account connection. Workspace availability stays the same.

If more than one plugin uses the same OAuth configuration, they share one connection.
Disconnecting one of them disconnects all of them.

## Built-in actions

Onyx also includes built-in actions that do not need a plugin:

| Name | Description | Requires Config | Provider Choices |
| - | - | - | - |
| Internal Search | Search through your organization's indexed documents and knowledge base | Yes | Built-in with swappable components |
| Web Search | Search the internet for real-time information and current events | Yes | Google, Serper, Exa, Firecrawl (optional) |
| Code Execution | Execute Python code, analyze data, and generate visualizations | No | Built-in |
| Image Generation | Create images from text descriptions using AI models | Yes | OpenAI, Azure OpenAI |
| Coding Agent <sup>Beta</sup> | Investigate and answer questions about a public GitHub codebase | Yes (disabled by default) | Built-in |

## For admins

> **[Manage plugins](/admins/plugins/overview)**
>
> Add plugins and set workspace availability.

> **[Craft Apps](/overview/core_features/craft_apps)**
>
> Let Craft act as you in Slack, Gmail, Notion, and more.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.