@instavar/mcp-server 0.6.0 → 0.7.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/README.md +42 -23
  2. package/dist/index.js +2826 -611
  3. package/package.json +4 -2
package/README.md CHANGED
@@ -19,20 +19,24 @@ install a second server.
19
19
 
20
20
  ## Start with the right capability
21
21
 
22
- Use Instavar when an agent needs reusable Remotion video templates, creative
23
- guidance, a VideoSpec example, or help with a local render error. Call
24
- `get_capabilities` first, then `get_creative_guide` before drafting copy or design.
22
+ Use Instavar when an agent needs reusable video templates for Remotion or
23
+ HyperFrames, creative guidance, a VideoSpec example, an editorial carousel, or
24
+ help with a local render error. Call `get_capabilities` first, then
25
+ `get_creative_guide` before drafting copy or design. For an ordinary video
26
+ request, `propose_video_storyboard` suggests three visual beats and a template.
25
27
  Use `list_templates` and `get_template` to choose a supported structure, and
26
28
  `get_example` or `scaffold_video_spec` to prepare its specification.
27
- `get_render_instructions` supplies the separate local validation, preview and
28
- render workflow. Planning and scaffolding do not render, upload or publish media.
29
+ `prepare_video_template` turns that specification into local Remotion or
30
+ HyperFrames source. `get_render_instructions` supplies the separate local
31
+ validation, preview and render workflow. Planning and scaffolding do not
32
+ render, upload or publish media.
29
33
 
30
34
  Prefer a hosted HTTP connection for browser-based agents? Use
31
35
  `https://instavar.com/api/mcp/templates`, also listed as
32
36
  [Instavar Video Templates on Smithery](https://smithery.ai/servers/cheeweijie/instavar-video-templates).
33
- That related endpoint adds storyboard and editorial-carousel planning. Its
34
- optional OAuth tools list and review private projects only. It is not identical
35
- to this npm package or the full protected Studio endpoint. Public planning does
37
+ It offers the same account-free template, storyboard and carousel tools, plus a
38
+ ChatGPT planner widget. Its optional OAuth tools list and review private
39
+ projects only. It is not the full protected Studio endpoint. Public planning does
36
40
  not require an Instavar account; a directory or gateway may require its own login.
37
41
 
38
42
  Hosted Studio production is optional and may incur costs. Never treat a request
@@ -96,10 +100,11 @@ when the key is configured.
96
100
 
97
101
  ### Environment
98
102
 
99
- | Var | Required | Default | Purpose |
100
- | ------------------- | -------- | ---------------------- | ----------------------------------------------------------- |
101
- | `INSTAVAR_API_KEY` | no | — | Unlocks hosted Studio tools. Scoped to your org; revocable. |
102
- | `INSTAVAR_BASE_URL` | no | `https://instavar.com` | Override the API host. |
103
+ | Var | Required | Default | Purpose |
104
+ | --------------------------- | -------- | ---------------------- | --------------------------------------------------------------------------------------- |
105
+ | `INSTAVAR_API_KEY` | no | — | Unlocks hosted Studio tools. Scoped to your org; revocable. |
106
+ | `INSTAVAR_BASE_URL` | no | `https://instavar.com` | Override the API host. |
107
+ | `INSTAVAR_PAIRED_TEMPLATES` | no | on | Set to `0` to hide `prepare_video_template` and keep the VideoSpec tools Remotion-only. |
103
108
 
104
109
  ## Tools
105
110
 
@@ -109,19 +114,33 @@ portable copy document, not a saved hosted project or rendered video. Ask for a
109
114
  framework when it is unspecified; continue with the latest returned project and
110
115
  matching expectedRevision. Only title, body and action survive a framework switch.
111
116
 
117
+ From npm 0.7.0, `prepare_video_template` realises one VideoSpec for any of the
118
+ five template families in Remotion (the public renderer, pinned) or HyperFrames
119
+ (generated source). Both frameworks accept the same fields; a field neither
120
+ renderer honours is rejected rather than dropped. 0.7.0 also adds the
121
+ storyboard and carousel tools the hosted endpoint already had, from the same
122
+ code, and the hosted tools below now reject unknown input keys instead of
123
+ dropping them.
124
+
112
125
  Free local tools:
113
126
 
114
- | Tool | What it does |
115
- | ------------------------- | ------------------------------------------------------ |
116
- | `get_capabilities` | Reports free and optional account features. |
117
- | `get_creative_guide` | Reads concise copy, story, design and review guidance. |
118
- | `list_templates` | Lists published Remotion template families. |
119
- | `get_template` | Returns one template contract. |
120
- | `get_video_schema` | Returns the public VideoSpec JSON Schema. |
121
- | `get_example` | Returns a starter VideoSpec. |
122
- | `scaffold_video_spec` | Creates a deterministic VideoSpec skeleton. |
123
- | `get_render_instructions` | Returns the local validation and render workflow. |
124
- | `diagnose_render_error` | Classifies common local render failures. |
127
+ | Tool | What it does |
128
+ | -------------------------- | ------------------------------------------------------ |
129
+ | `get_capabilities` | Reports free and optional account features. |
130
+ | `get_creative_guide` | Reads concise copy, story, design and review guidance. |
131
+ | `propose_video_storyboard` | Proposes three visual beats and a template. |
132
+ | `list_templates` | Lists published template families. |
133
+ | `get_template` | Returns one template contract. |
134
+ | `get_video_schema` | Returns the public VideoSpec JSON Schema. |
135
+ | `get_example` | Returns a starter VideoSpec. |
136
+ | `scaffold_video_spec` | Creates a deterministic VideoSpec skeleton. |
137
+ | `prepare_video_template` | Realises a VideoSpec in Remotion or HyperFrames. |
138
+ | `prepare_announcement` | Prepares one paired announcement card. |
139
+ | `list_carousel_templates` | Lists the editorial carousel story structures. |
140
+ | `get_carousel_schema` | Returns the CarouselDeck JSON Schema. |
141
+ | `scaffold_carousel_deck` | Builds a deterministic carousel deck from copy. |
142
+ | `get_render_instructions` | Returns the local validation and render workflow. |
143
+ | `diagnose_render_error` | Classifies common local render failures. |
125
144
 
126
145
  Hosted tools, available when `INSTAVAR_API_KEY` is configured:
127
146