@instavar/mcp-server 0.5.0 → 0.6.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 +39 -14
  2. package/dist/index.js +635 -316
  3. package/package.json +1 -1
package/README.md CHANGED
@@ -17,6 +17,27 @@ thin HTTP clients to the hosted Instavar API. The package holds **no database
17
17
  connection** and stores no data of its own. You keep the free tools and do not
18
18
  install a second server.
19
19
 
20
+ ## Start with the right capability
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.
25
+ Use `list_templates` and `get_template` to choose a supported structure, and
26
+ `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
+
30
+ Prefer a hosted HTTP connection for browser-based agents? Use
31
+ `https://instavar.com/api/mcp/templates`, also listed as
32
+ [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
36
+ not require an Instavar account; a directory or gateway may require its own login.
37
+
38
+ Hosted Studio production is optional and may incur costs. Never treat a request
39
+ to plan a video as permission to render a paid job or publish a social post.
40
+
20
41
  ## Which model runs?
21
42
 
22
43
  The MCP host supplies the general-purpose LLM.
@@ -38,10 +59,7 @@ hosted services, including rendering,
38
59
  storage, specialist media generation, QA, publishing, and other declared job
39
60
  costs. Using a subscription-backed agent does not make those services free.
40
61
 
41
- For the full architecture, see
42
- [`docs/architecture/studio-agent-workflow-architecture.md`](../../docs/architecture/studio-agent-workflow-architecture.md).
43
- For dated provider evidence, see
44
- [`reports/research/subscription-backed-agent-runtime-2026-07-10.md`](../../reports/research/subscription-backed-agent-runtime-2026-07-10.md).
62
+ For public setup guidance and examples, see [Instavar video templates](https://instavar.com/remotion).
45
63
 
46
64
  ## Setup
47
65
 
@@ -85,18 +103,25 @@ when the key is configured.
85
103
 
86
104
  ## Tools
87
105
 
106
+ From npm 0.6.0 the package also includes `prepare_announcement`: one paired
107
+ announcement card for Remotion and HyperFrames. It returns local source and a
108
+ portable copy document, not a saved hosted project or rendered video. Ask for a
109
+ framework when it is unspecified; continue with the latest returned project and
110
+ matching expectedRevision. Only title, body and action survive a framework switch.
111
+
88
112
  Free local tools:
89
113
 
90
- | Tool | What it does |
91
- | ------------------------- | ------------------------------------------------- |
92
- | `get_capabilities` | Reports free and optional account features. |
93
- | `list_templates` | Lists published Remotion template families. |
94
- | `get_template` | Returns one template contract. |
95
- | `get_video_schema` | Returns the public VideoSpec JSON Schema. |
96
- | `get_example` | Returns a starter VideoSpec. |
97
- | `scaffold_video_spec` | Creates a deterministic VideoSpec skeleton. |
98
- | `get_render_instructions` | Returns the local validation and render workflow. |
99
- | `diagnose_render_error` | Classifies common local render failures. |
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. |
100
125
 
101
126
  Hosted tools, available when `INSTAVAR_API_KEY` is configured:
102
127