Skip to main content
Glama

Store a source-free advert plan

soclo_host_plan_import
Idempotent

Store a source-free host-authored plan in Soclo (actors/references/voices empty). Needs projectId, clientRequestId, the catalogueVersion and guides returned by soclo_host_plan_prepare unchanged, the complete input and the complete plan. A first import must give every scene on-screen-text cue a "render" design (version "model-text.1" or "caption-design.1"). Spends no customer credits and makes no AI, quote, reservation, media generation or render call; quote and render remain separate later calls that require their own consent. When Soclo refuses a document it names the offending field in "details" — correct that field and resend; when the write reply is uncertain, reconcile under the same ids and content with soclo_host_plan_recover instead of retrying blindly. This import grants no provider or Autopilot authority.

Input Schema

NameRequiredDescriptionDefault
planYes
inputYes
guidesYesBy default carry the exact guides returned by prepare into import/import_selected. Soclo selected them from the brief; keep their revision and digest unchanged. An unavailable selector may return [], allowing the host to proceed.
projectIdYes
clientRequestIdYes
catalogueVersionYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changed
    • changedInput schema / properties / clientRequestId / pattern
      Previous value: -"^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$"New value: +"^[0-9a-f]{8}-[0-9a-f]{4}-[1-8][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$"
    • changedInput schema / properties / projectId / pattern
      Previous value: -"^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$"New value: +"^[0-9a-f]{8}-[0-9a-f]{4}-[1-8][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$"
  2. Changed1 schema field changed
    • changedInput schema / properties / guides / description
      Previous value: -"By default carry the exact guides returned by prepare into import/import_selected. Jev selected them from the brief; keep their certified revision and whole-entry digest. An unavailable selector may return [], allowing the host to proceed."New value: +"By default carry the exact guides returned by prepare into import/import_selected. Soclo selected them from the brief; keep their revision and digest unchanged. An unavailable selector may return [], allowing the host to proceed."
  3. Changed2 schema fields changed
    • addedInput schema / definitions
      Added value: +{
      +  "s1": {
      +    "additionalProperties": false,
      +    "properties": {
      +      "basis": {
      +        "const": "planned-scene",
      +        "type": "string"
      +      },
      +      "fromSeconds": {
      +        "description": "Scene-relative start, non-negative.",
      +        "type": "number"
      +      },
      +      "sceneSeconds": {
      +        "description": "Must equal the scene’s own seconds.",
      +        "type": "number"
      +      },
      +      "toSeconds": {
      +        "description": "Scene-relative end, later than fromSeconds and not past sceneSeconds.",
      +        "type": "number"
      +      }
      +    },
      +    "required": [
      +      "basis",
      +      "sceneSeconds",
      +      "fromSeconds",
      +      "toSeconds"
      +    ],
      +    "type": "object"
      +  }
      +}
    • changedInput schema / properties / plan / properties / scenes / items / properties / onScreenText / items / properties / render / oneOf
      Previous value: -[
      -  {
      -    "additionalProperties": false,
      -    "properties": {
      -      "placement": {
      -        "description": "Where and how the model should show the text in the generated shot.",
      -        "type": "string"
      -      },
      -      "timing": {
      -        "additionalProperties": false,
      -        "properties": {
      -          "basis": {
      -            "const": "planned-scene",
      -            "type": "string"
      -          },
      -          "fromSeconds": {
      -            "description": "Scene-relative start, non-negative.",
      -            "type": "number"
      -          },
      -          "sceneSeconds": {
      -            "description": "Must equal the scene’s own seconds.",
      -            "type": "number"
      -          },
      -          "toSeconds": {
      -            "description": "Scene-relative end, later than fromSeconds and not past sceneSeconds.",
      -            "type": "number"
      -          }
      -        },
      -        "required": [
      -          "basis",
      -          "sceneSeconds",
      -          "fromSeconds",
      -          "toSeconds"
      -        ],
      -        "type": "object"
      -      },
      -      "version": {
      -        "const": "model-text.1",
      -        "type": "string"
      -      }
      -    },
      -    "required": [
      -      "version",
      -      "timing",
      -      "placement"
      -    ],
      -    "type": "object"
      -  },
      -  {
      -    "additionalProperties": false,
      -    "properties": {
      -      "layout": {
      -        "additionalProperties": false,
      -        "properties": {
      -          "baselineYN": {
      -            "type": "number"
      -          },
      -          "centerXN": {
      -            "type": "number"
      -          },
      -          "color": {
      -            "description": "Six-digit #RRGGBB.",
      -            "type": "string"
      -          },
      -          "fontSizeHeightN": {
      -            "type": "number"
      -          }
      -        },
      -        "required": [
      -          "centerXN",
      -          "baselineYN",
      -          "fontSizeHeightN",
      -          "color"
      -        ],
      -        "type": "object"
      -      },
      -      "motion": {
      -        "oneOf": [
      -          {
      -            "additionalProperties": false,
      -            "properties": {
      -              "kind": {
      -                "const": "hold",
      -                "type": "string"
      -              }
      -            },
      -            "required": [
      -              "kind"
      -            ],
      -            "type": "object"
      -          },
      -          {
      -            "additionalProperties": false,
      -            "properties": {
      -              "completeAtSeconds": {
      -                "type": "number"
      -              },
      -              "kind": {
      -                "const": "word-reveal",
      -                "type": "string"
      -              }
      -            },
      -            "required": [
      -              "kind",
      -              "completeAtSeconds"
      -            ],
      -            "type": "object"
      -          },
      -          {
      -            "additionalProperties": false,
      -            "properties": {
      -              "kind": {
      -                "const": "pop",
      -                "type": "string"
      -              },
      -              "peakAfterSeconds": {
      -                "type": "number"
      -              },
      -              "peakScale": {
      -                "type": "number"
      -              },
      -              "revealAtSeconds": {
      -                "type": "number"
      -              },
      -              "settleAfterSeconds": {
      -                "type": "number"
      -              },
      -              "startScale": {
      -                "type": "number"
      -              },
      -              "target": {
      -                "enum": [
      -                  "whole-cue",
      -                  "last-word"
      -                ],
      -                "type": "string"
      -              }
      -            },
      -            "required": [
      -              "kind",
      -              "target",
      -              "revealAtSeconds",
      -              "peakAfterSeconds",
      -              "settleAfterSeconds",
      -              "startScale",
      -              "peakScale"
      -            ],
      -            "type": "object"
      -          }
      -        ]
      -      },
      -      "timing": {
      -        "additionalProperties": false,
      -        "properties": {
      -          "basis": {
      -            "const": "planned-scene",
      -            "type": "string"
      -          },
      -          "fromSeconds": {
      -            "description": "Scene-relative start, non-negative.",
      -            "type": "number"
      -          },
      -          "sceneSeconds": {
      -            "description": "Must equal the scene’s own seconds.",
      -            "type": "number"
      -          },
      -          "toSeconds": {
      -            "description": "Scene-relative end, later than fromSeconds and not past sceneSeconds.",
      -            "type": "number"
      -          }
      -        },
      -        "required": [
      -          "basis",
      -          "sceneSeconds",
      -          "fromSeconds",
      -          "toSeconds"
      -        ],
      -        "type": "object"
      -      },
      -      "version": {
      -        "const": "caption-design.1",
      -        "type": "string"
      -      }
      -    },
      -    "required": [
      -      "version",
      -      "timing",
      -      "layout",
      -      "motion"
      -    ],
      -    "type": "object"
      -  }
      -]New value: +[
      +  {
      +    "additionalProperties": false,
      +    "properties": {
      +      "placement": {
      +        "description": "Where and how the model should show the text in the generated shot.",
      +        "type": "string"
      +      },
      +      "timing": {
      +        "$ref": "#/definitions/s1"
      +      },
      +      "version": {
      +        "const": "model-text.1",
      +        "type": "string"
      +      }
      +    },
      +    "required": [
      +      "version",
      +      "timing",
      +      "placement"
      +    ],
      +    "type": "object"
      +  },
      +  {
      +    "additionalProperties": false,
      +    "properties": {
      +      "layout": {
      +        "additionalProperties": false,
      +        "properties": {
      +          "baselineYN": {
      +            "type": "number"
      +          },
      +          "centerXN": {
      +            "type": "number"
      +          },
      +          "color": {
      +            "description": "Six-digit #RRGGBB.",
      +            "type": "string"
      +          },
      +          "fontSizeHeightN": {
      +            "type": "number"
      +          }
      +        },
      +        "required": [
      +          "centerXN",
      +          "baselineYN",
      +          "fontSizeHeightN",
      +          "color"
      +        ],
      +        "type": "object"
      +      },
      +      "motion": {
      +        "oneOf": [
      +          {
      +            "additionalProperties": false,
      +            "properties": {
      +              "kind": {
      +                "const": "hold",
      +                "type": "string"
      +              }
      +            },
      +            "required": [
      +              "kind"
      +            ],
      +            "type": "object"
      +          },
      +          {
      +            "additionalProperties": false,
      +            "properties": {
      +              "completeAtSeconds": {
      +                "type": "number"
      +              },
      +              "kind": {
      +                "const": "word-reveal",
      +                "type": "string"
      +              }
      +            },
      +            "required": [
      +              "kind",
      +              "completeAtSeconds"
      +            ],
      +            "type": "object"
      +          },
      +          {
      +            "additionalProperties": false,
      +            "properties": {
      +              "kind": {
      +                "const": "pop",
      +                "type": "string"
      +              },
      +              "peakAfterSeconds": {
      +                "type": "number"
      +              },
      +              "peakScale": {
      +                "type": "number"
      +              },
      +              "revealAtSeconds": {
      +                "type": "number"
      +              },
      +              "settleAfterSeconds": {
      +                "type": "number"
      +              },
      +              "startScale": {
      +                "type": "number"
      +              },
      +              "target": {
      +                "enum": [
      +                  "whole-cue",
      +                  "last-word"
      +                ],
      +                "type": "string"
      +              }
      +            },
      +            "required": [
      +              "kind",
      +              "target",
      +              "revealAtSeconds",
      +              "peakAfterSeconds",
      +              "settleAfterSeconds",
      +              "startScale",
      +              "peakScale"
      +            ],
      +            "type": "object"
      +          }
      +        ]
      +      },
      +      "timing": {
      +        "$ref": "#/definitions/s1"
      +      },
      +      "version": {
      +        "const": "caption-design.1",
      +        "type": "string"
      +      }
      +    },
      +    "required": [
      +      "version",
      +      "timing",
      +      "layout",
      +      "motion"
      +    ],
      +    "type": "object"
      +  }
      +]
  4. First observed

TDQS

A4.5/5.0
Behavior5/5

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

Goes well beyond the annotations (readOnlyHint=false, idempotentHint=true, destructiveHint=false) by disclosing the credit and side-effect profile: no customer credits spent, no AI/quote/reservation/media/render call, quote and render are separate consent-gated calls, and no provider or Autopilot authority is granted. It also documents the rejection behavior (offending field named in "details") and the reconciliation path under the same ids, which is exactly the context an agent needs for a mutating write.

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

Conciseness4/5

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

Purpose and the source-free qualifier are front-loaded, then prerequisites, side effects, and error handling in that order. Some sentences are dense run-ons (the first-import render-design rule), but no sentence is filler and each carries a distinct constraint.

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?

For a six-parameter, deeply nested mutation with no output schema, the description covers credits, external-call boundaries, consent, first-import validation, error semantics, and recovery. The remaining gap is the return value — the agent is not told what a successful import yields or how to identify the stored plan afterward — which matters given no output schema exists.

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

Parameters4/5

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

Top-level schema description coverage is only 17%, so the description has to carry meaning, and it names all six required parameters and adds real semantics: guides and catalogueVersion must be carried unchanged from prepare, and clientRequestId is the key used for reconciliation. It does not explain the input-vs-plan split or the constraints/modelChoice substructure, which the nested schema partially covers on its own.

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 ("Store a source-free host-authored plan in Soclo") and immediately qualifies the scope with "(actors/references/voices empty)", which is what separates it from the sibling soclo_host_plan_import_selected. An agent can pick between the two 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?

Names the prerequisite producer (catalogueVersion and guides "returned by soclo_host_plan_prepare unchanged") and routes failure cases explicitly to soclo_host_plan_recover rather than a blind retry. It implies but never names soclo_host_plan_import_selected as the alternative for selected imports, so the exclusion is only half-explicit.

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