> For the complete documentation index, see [llms.txt](https://docs.scaleconnect.com.au/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.scaleconnect.com.au/api/plugins.md).

# Plugins

{% @scale-docs-page-title/page-title title="Plugins" %}

{% hint style="warning" %}
**Confirm before publishing:** whether a plugin platform or SDK will ship, installation flow, manifest schema, permission model, supported UI surfaces, version compatibility, review process and revocation behaviour. The examples here describe the intended contract; a public plugin installation endpoint and SDK have not been verified.
{% endhint %}

A plugin packages an integration so a workspace can discover, install and manage it. It may use [Connections](/api/connections.md) to link a provider, [REST](/api/rest-api.md) for data, [Webhooks](/api/webhooks.md) for changes and [MCP](/api/mcp.md) for AI tool access. Installing a plugin should not grant every API scope automatically.

## Plugin lifecycle

1. The developer registers a plugin with an owner, version, support contact and requested capabilities.
2. Scale reviews its manifest, scopes, callbacks, data handling and user-facing copy.
3. A brokerage admin installs it and consents to the specific scopes and provider connections.
4. The plugin receives only the credentials and events needed for its approved workflows.
5. The admin can inspect permissions, disconnect a provider, rotate credentials or uninstall it.
6. Revocation stops API calls, tool execution and future webhook deliveries for that installation.

## Manifest contents

| Field group   | Meaning                                            |
| ------------- | -------------------------------------------------- |
| Identity      | Stable plugin ID, name, publisher and version      |
| Surfaces      | Where the plugin appears and what action opens it  |
| Permissions   | Required and optional API scopes                   |
| Connections   | Provider accounts and OAuth scopes requested       |
| Events        | Webhook types consumed or emitted                  |
| Tools         | MCP tools exposed and their backing API operations |
| Compatibility | Minimum supported API and host versions            |
| Support       | Documentation, privacy policy and contact          |

The final manifest schema should be published as a versioned machine-readable definition with a validated example. A plugin update that asks for new scopes requires renewed administrator consent.

## Plugin, connection or MCP?

Use a **connection** for a linked provider account, **MCP** when an AI client calls approved tools, and a **plugin** when the integration has an installable product lifecycle or UI. The same integration can use all three, but each has a separate authorization and revocation path.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.scaleconnect.com.au/api/plugins.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.