Add your own plugin to the workspace

Open in Agentum

Purpose

The shop's order system is not in the catalog, so Kian adds it himself. Add a tool provider of your own, either an MCP server or an API described by an OpenAPI specification, so agents in the workspace can use it after it is connected.

Before you start

You need permission to manage plugins in this workspace. Have the provider's address and connection details ready (server URL or specification, and an API key, token or OAuth client if it needs one). Keep secrets out of chats and shared documents. The plugin is added to the workspace you have selected.

Steps

  1. Open "Plugins" and select "Add plugin" in the page header.
  2. Under "Plugin details" fill in "Name", "Description", "Developer", "Category", "Website" and "Version" (all required). Choose the "Plugin icon" and "Plugin color". Optionally add "Capabilities", separated by commas or new lines, and "Privacy policy" and "Terms of service" addresses.
  3. Under "Connection", choose the "Provider": "MCP" or "OpenAPI".
    • MCP: enter the "MCP server URL" and choose the "Transport", "Streamable HTTP" or "SSE".
    • OpenAPI: paste the JSON or YAML text into "OpenAPI specification". Fill "API base URL" only when the specification does not give a full server address.
  4. Choose the "Authentication": "No authentication", "OAuth 2.1", "API key" or "Bearer token".
    • "API key": enter the "API key header" and the key.
    • "Bearer token": enter the token.
    • "OAuth 2.1": optionally enter "OAuth client ID", "OAuth client secret" and "OAuth scopes" (leave the client ID empty when the provider supports automatic registration).
  5. Select "Add plugin" and wait. For sign-in-based plugins, tool discovery happens after you connect. Other plugins are checked while being added: Agentum contacts the provider to discover its tools. When it succeeds, the new plugin's page opens. Connect it next (see "Connect a plugin"), then give an agent access: for the default agent in Settings, "Plugins" (see "Plugin tools"), for a custom agent in its "Plugins" section.

Expected result

The plugin appears in the plugins list with a "Workspace" badge. Adding it does not connect it and does not give agents access. Secrets are stored encrypted.

Field Limit
Name, Developer 2 to 80 characters
Description 10 to 300 characters
Version 1 to 30 characters
Website, server URL, Privacy policy, Terms of service A valid address, up to 500 characters
Capabilities Up to 12 entries, each up to 100 characters
OpenAPI specification Up to 1,500,000 characters
OAuth client ID Up to 500 characters
OAuth client secret, OAuth scopes Up to 2,000 characters
API key header Up to 100 characters
API key or bearer token Up to 4,000 characters

Troubleshooting

Problem What to do
"Add plugin" is disabled or the form will not submit Fill the required fields and make sure at least one category exists in the list.
An error appears and the window stays open Read it, correct the address or credentials, and try again. If the creation check fails because the provider cannot be reached, nothing is added. (Sign-in-based plugins are not checked until you connect.)
An error says the plugin address can't be used Use a public https address. Addresses that are not https, or that point to a private or internal network, are refused.
The plugin has no tools after connecting Check the address and credentials, then disconnect and connect again.

Was this helpful?