MCP / Resources

Resources

Resource families are read-only, URI-addressable snapshots returned as resource_links from tool calls. Use them for large payloads (canon summaries, screenplay snapshots, wizard results) instead of inlining the whole object in a tool response.

FamilyTitleTypeDescription
account_statusAccount Statusapplication/jsonv1Caller-scoped BeatBandit account state including credits plus current default LLM and video model preferences.
analysis_wizard_resultAnalysis Wizard Resultapplication/jsonlargev1Read-only finalized Analysis Wizard scores, comments, and rewrite guidance.
asset_contentAsset Contentapplication/octet-streamlargev1Binary content for one generated BeatBandit asset, delivered through BeatBandit instead of expiring storage URLs.
change_wizard_resultChange Story Resultapplication/jsonlargev1Read-only finalized Change Story proposed changes and summary.
creative_canvas_resultCreative Canvas Resultapplication/jsonlargev1Read-only finalized Creative Canvas directions.
diff_proposalDiff Proposalapplication/jsonlargev1Full MCP diff proposal envelope for one saved rewrite or persona proposal.
episode_screenplay_resultEpisode Screenplay Resultapplication/jsonlargev1Read-only episodic screenplay generation result for one parent job.
export_artifactExport Artifactapplication/jsonlargeplannedRead-only export artifact metadata or links.
media_catalogMedia Catalogapplication/jsonlargev1Paginated catalog of generated media assets for one project.
mentor_decisionsStory Mentor Decisionsapplication/jsonv1Latest durable Story Mentor decision snapshot for one project.
novel_auditsNovel Audit Runsapplication/jsonlargev1Read-only history and findings for Novel continuity audit runs.
novel_blueprintNovel Blueprintapplication/jsonlargev1Read-only authored Novel development, including unfinished Foundation and Direction; source diagnosis and adaptation units exist only for adaptations.
novel_candidateNovel Manuscript Candidateapplication/jsonlargev1Read-only complete current and proposed Chapter documents for one Writer review checkpoint.
novel_canonNovel Canon Ledgerapplication/jsonlargev1Read-only canonical continuity ledger for a Novel project.
novel_changesNovel Review Changesapplication/jsonlargev1Read-only Chapters flagged by upstream changes and open shared manuscript proposal summaries.
novel_chapterNovel Chapterapplication/jsonlargev1Read-only complete prose and canonical editable Lexical body, including private author notes and formatting, compact Chapter plan and linked source units. Excludes generation-debug payloads.
novel_manuscriptNovel Manuscriptapplication/jsonlargev1Read-only canonical manuscript assembly in Chapter order.
novel_sourceNovel Adaptation Sourceapplication/jsonlargev1Read-only normalized source package used by a Novel adaptation project.
novel_source_unitNovel Adaptation Source Unitapplication/jsonlargev1Read-only canonical source text and metadata for one source unit linked from a Novel Chapter.
novel_voiceNovel Writing Voiceapplication/jsonlargev1Read-only complete Voice Guidelines, Writing Samples, and revision state for a Novel project.
novel_voice_proposalNovel Voice Options Proposalapplication/jsonlargev1Read-only complete Voice Options proposal and proof excerpts for an explicitly selected completed job.
polish_wizard_resultPolish Screenplay Resultapplication/jsonlargev1Read-only finalized Polish Screenplay suggestions and conflicts.
project_canon_summaryProject Canon Summaryapplication/jsonlargev1Compact read-only summary of a BeatBandit project canon.
project_chat_historyProject Chat Historyapplication/jsonlargev1Paginated freeform project chat history for one project stage.
project_diff_proposalsDiff Proposal Inboxapplication/jsonlargev1Recent unapplied MCP diff proposals for one project, including rewrite and persona proposals that can still be applied.
project_preferencesProject Preferencesapplication/jsonv1Effective chat-facing project preferences, including provider/model defaults and the default stage snapshot.
project_updatesProject Updatesapplication/jsonlargev1Current rewrite and structural-sync update queue for one project.
room_review_resultRoom Review Resultapplication/jsonlargev1Read-only finalized Room Review summary and notes.
screenplay_documentScreenplay Document Snapshotapplication/jsonlargev1Read-only snapshot of the structured screenplay document. Use the screenplay_sequence resource for a sequence-scoped read.
screenplay_sceneScreenplay Scene Snapshotapplication/jsonlargev1Read-only snapshot of one screenplay scene.
screenplay_sequenceScreenplay Sequence Snapshotapplication/jsonlargev1Read-only movie sequence slice using the same scene membership as screenplay_read. sequence_number must be an integer from 1 to 8; episodic documents require episode reads.
screenplay_writing_voiceScreenplay Writing Voiceapplication/jsonlargev1Complete revisioned project Writing Voice artifact, including explicitly requested samples.
screenplay_writing_voice_proposalScreenplay Writing Voice Proposalapplication/jsonlargev1Completed editable Screenplay Writing Voice analysis proposal and its base expected revision.
sequence_wizard_resultSequence Wizard Resultapplication/jsonlargev1Read-only finalized Sequence Wizard update summary.
shot_element_libraryShot Element Libraryapplication/jsonlargev1Paginated recurring shot-element library for one project.
shot_list_scopeShot List Scopeapplication/jsonlargev1Read-only snapshot of a shot-list scope.
story_mentor_sessionStory Mentor Sessionapplication/jsonlargev1Story Mentor transcript, decision state, and active turn snapshot for one session.
template_manifestTemplate Manifestapplication/jsonv1Read-only BeatBandit template manifest.
treatment_wizard_resultTreatment Wizard Resultapplication/jsonlargev1Read-only finalized Treatment Wizard sections and update summary.
visual_style_effectiveEffective Visual Styleapplication/jsonv1Read-only effective visual style resolution for a project, scene, or shot scope.
weave_resultWeave Resultapplication/jsonlargev1Read-only finalized Weave result with saved episodes and warnings.