Semogram Docs
MCPTools reference

plugin_installation_create

Validate discovery and install all enabled capabilities for a plugin in the authenticated workspace.

When to use it

Use plugin_installation_create to install and configure a plugin. This tool operates at workspace scope. It does not require a project context unless a filtering argument explicitly asks for one.

Arguments

NameTypeRequiredDefaultConstraints
capabilityClassstringYes—Allowed: "reads", "writes", "factStores", "secretProviders", "mcpServers", "transforms"
discoveryIdstringYes—Minimum length: 1
namestringNo—Minimum length: 1; Maximum length: 160
configobjectNo{}See the full input schema
idempotencyKeystringYes—Minimum length: 8; Maximum length: 200

View the complete input schema, including nested contracts and alternative shapes. The schema is extracted from the workspace server’s Zod definitions. Runtime validation also enforces custom checks that JSON Schema cannot express.

Response shape

The implementation constructs payloads using these fields: installation. The returned fields depend on the execution path.

MCP returns a text block containing the JSON operation result and a structuredContent copy. The envelope includes data, completeness, truncated, freshness, and warnings. Depending on the operation it can also include nextCursor, evidence, job, or receipt.

Check those fields before treating a conversational summary as the result. When a job is returned, inspect its status with the appropriate execution tool; a queued response is not confirmation that work finished. Follow evidence links when checking the underlying records.

Input methods

This request illustrates the argument structure. Replace every angle-bracket placeholder with a real value and supply any applicable optional fields from the schema. Nested business contracts must match your actual configuration. Send it through an authenticated, initialized MCP client; this JSON alone does not establish a session or sign you in.

Open workspace Plugins. For creation, choose Explore, select the matching plugin/capability and fill its installation fields. For an existing installation, select it in the installed list and inspect its connection settings before editing, checking or removing it. Keep credentials in protected fields and review changes before saving.

Use Semogram’s plugin_installation_create tool to install and configure a plugin. Inspect the required inputs and target first, then show me what will change before executing it.

Use real resource IDs returned by earlier reads; a resource name is not a UUID. Do not fill missing business inputs with invented values.

This is an MCP tools/call request, not a form to paste into Semogram. Send it through an authenticated, initialized MCP client.

MCP request
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "plugin_installation_create",
    "arguments": {
      "capabilityClass": "reads",
      "discoveryId": "<DISCOVERY_ID>",
      "idempotencyKey": "<UNIQUE_KEY_FOR_THIS_OPERATION>"
    }
  }
}

This operation has no standalone public /api/v1 plugin-installation/catalog route in the current implementation. Use the UI or MCP methods shown here.

FAQ

What access and approvals are required?

Required permission scopes: plugins:write. OAuth uses current workspace membership; API keys use their assigned scopes and grants. Discovery can exclude tools the caller cannot use.

Read-only annotation: No. Destructive annotation: No. Follow the operation’s declared contract and any applicable server-side approval policy.

How should I handle retries?

The server marks this operation as idempotent. When an idempotencyKey is accepted, keep the same key only for a retry of the exact same input; use a new key for new work. For 429 responses, honor Retry-After rather than retrying immediately.

Why is this tool missing or returning an error?

Confirm the workspace, resource IDs, and permission scopes. Read the returned error before changing the request. See connection, authentication and troubleshooting for sign-in, scope, resource access, and rate-limit errors.