Skip to main content
Glama

propose_plugin_preview

Propose a plugin via MCP and generate a live preview URL for the user to review in the web UI. Once the user approves it (either in the UI or via approve_plugin_preview), it becomes a fully saved plugin.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "id": "<id>",
      "name": "<name>",
      "schema_json": "<schema_json>"
    },
    "name": "propose_plugin_preview"
  }
}

Input Schema

NameRequiredDescriptionDefault
idYesPlugin ID (kebab-case)
nameYesHuman readable plugin name
modulesNoOptional additional files (e.g. { "utils.ts": "..." })
categoryNoPlugin category (e.g. "content", "visual")
scene_codeNoThe main React source code for Scene.tsx
descriptionNoShort description of what the block does
schema_jsonYesA JSON string of the block's schema
dependenciesNonpm dependencies the plugin imports (package -> semver)

Output Schema

NameRequiredDescriptionDefault
previewUrlNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.2/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations only declare the mutation/open-world/safe-to-repeat profile; the description adds the important lifecycle fact that this does not immediately persist a plugin — it creates a preview that only becomes saved after approval, with two approval channels. It does not cover preview expiry, ID collisions, or validation failure behavior, which are notable gaps for a staged-write tool.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Two sentences, zero filler, with the purpose and the review/approval lifecycle front-loaded. Every clause carries information the agent needs to act.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

With an output schema present, the description need not explain the returned preview URL, and the lifecycle from proposal to saved plugin is covered. What remains underspecified is failure and edge behavior — invalid schema_json, duplicate id, or whether re-proposing replaces an existing preview.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100% across all 8 parameters, so the heavy lifting is already done by structured fields. The description adds no extra meaning about how id, schema_json, scene_code, or modules interact (for example, whether schema_json must match the code), so the baseline applies.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb and resource ("Propose a plugin") plus the concrete outcome ("generate a live preview URL for the user to review in the web UI"). It also distinguishes itself from the sibling approve_plugin_preview by framing that tool as the follow-up step, so an agent can tell the two apart without opening either schema.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Makes the usage context explicit: use this to stage a plugin and obtain a reviewable preview, with approve_plugin_preview (or the UI) as the path to finalization. It lacks explicit "do not use when" exclusions, such as when a plugin already exists or when only inspection is needed (get_plugin/list_plugins), but the workflow positioning is clear.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources