@paradigma-inc/flywheel 0.1.25 → 0.1.35
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.
- package/package.json +1 -1
- package/skills/flywheel/example-workflows/organizing-exploring-and-iterating-on-a-research-topic.md +11 -11
- package/skills/flywheel/example-workflows/reproducing-papers-on-a-budget.md +8 -8
- package/skills/flywheel/references/ARTIFACTS.md +48 -0
- package/skills/flywheel/references/INTERFACES.md +206 -0
- package/skills/flywheel/references/experiment-design-protocol.md +5 -5
- package/skills/flywheel/references/flywheel-mcp-tool-map.md +73 -59
- package/skills/flywheel-auto/SKILL.md +4 -4
- package/skills/flywheel-auto/references/ARTIFACTS.md +1 -1
- package/skills/flywheel-auto/references/INTERFACES.md +60 -58
- package/skills/flywheel-auto/references/experiment-design-protocol.md +5 -5
- package/skills/flywheel-auto/references/flywheel-mcp-tool-map.md +73 -59
- package/skills/flywheel-lookahead/references/ARTIFACTS.md +1 -1
- package/skills/flywheel-lookahead/references/INTERFACES.md +60 -58
- package/skills/flywheel-lookahead/references/flywheel-mcp-tool-map.md +73 -59
- package/skills/flywheel-prove/SKILL.md +8 -0
- package/skills/flywheel-reproduce/SKILL.md +4 -4
- package/skills/flywheel-reproduce/references/ARTIFACTS.md +1 -1
- package/skills/flywheel-reproduce/references/INTERFACES.md +60 -58
- package/skills/flywheel-reproduce/references/experiment-design-protocol.md +5 -5
- package/skills/flywheel-reproduce/references/flywheel-mcp-tool-map.md +73 -59
- package/skills/flywheel-to-graph/SKILL.md +4 -4
- package/skills/flywheel-to-graph/references/ARTIFACTS.md +1 -1
- package/skills/flywheel-to-graph/references/INTERFACES.md +60 -58
- package/skills/flywheel-to-graph/references/flywheel-mcp-tool-map.md +73 -59
- package/skills/flywheel-tree/SKILL.md +61 -0
- package/skills/flywheel-tree/agents/interface.yaml +4 -0
- package/skills/flywheel-tree/assets/ansi_palette.json +29 -0
- package/skills/flywheel-tree/references/workflow.md +108 -0
- package/skills/flywheel-tree/scripts/render_tree.py +407 -0
- package/skills/flywheel-tree/scripts/render_tree_via_mcp.py +694 -0
|
@@ -12,6 +12,16 @@ Flywheel is a graph-based system for tracking research work, decisions, and evid
|
|
|
12
12
|
- Node references include immutable `node_id` and optional immutable `slug_name`; prefer communicating both together for human clarity and disambiguation.
|
|
13
13
|
- Insight nodes should represent conceptual observations (theoretical insights, intuitions, motivations, decision-relevant framing); empirical nodes should represent experiments with explicit hypotheses and measured outcomes.
|
|
14
14
|
- Graph topology should encode logical/causal relations between concepts and experiments. Avoid defaulting to shallow root-only branching unless work items are truly independent.
|
|
15
|
+
- Node staging is local (non-canonical) and commit is the only canonical persistence boundary (`commit_new_node`, `commit_node`).
|
|
16
|
+
- Mutating node writes are optimistic-locking operations: read latest state, pass `expected_revision` or `base_committed_revision` as required, and handle `409 conflict` with explicit reconciliation.
|
|
17
|
+
- Mutating operations are idempotent; MCP tool transport auto-manages `Idempotency-Key` on mutating tool calls.
|
|
18
|
+
- Existing-node field editing may use a session-scoped stage lease (`flywheel_acquire_stage_lease`, `flywheel_heartbeat_stage_lease`, `flywheel_release_stage_lease`) to coordinate local staged state before commit.
|
|
19
|
+
- Existing-node commit publishes a full staged payload under an active stage lease: commit requests require `stage_session_id`, `base_committed_revision`, and `staged_payload`; conflicts on stale committed revisions are surfaced directly and are not transport-retried.
|
|
20
|
+
- Stage/backfill helpers (`stage_backfill_hypothesis`, `stage_backfill_insights`) return non-canonical staged payload patches and explicit status fields (`staged_changes_pending`, `commit_required`, `next_action_hint`).
|
|
21
|
+
- Committed node state must still satisfy strict contract (`summary` required; `empirical` requires hypothesis plus artifacts or `no_artifacts_reason`; `insight` requires non-empty insights).
|
|
22
|
+
- When code is involved, pass `repo_url`/`branch_name`/`head_commit_sha` and align git structure with graph topology where practical (without forcing one-to-one mapping).
|
|
23
|
+
- Summaries, hypotheses, and artifacts should be reproduction-grade: enough setup, method, evidence, and interpretation for another reader to reproduce or audit results.
|
|
24
|
+
- Empirical workflow is hypothesis-driven: launch execution, inspect outcomes, publish evidence artifacts, and commit only after terminal status.
|
|
15
25
|
- For empirical work, publish evidence with `flywheel_prepare_artifact_uploads`, upload raw file bytes, then `flywheel_finalize_artifact_uploads` before commit.
|
|
16
26
|
- Artifact metadata records expose a non-empty `title` suitable for display labels; title normalization must never derive from `storage_url`.
|
|
17
27
|
|
|
@@ -21,83 +31,84 @@ Flywheel is a graph-based system for tracking research work, decisions, and evid
|
|
|
21
31
|
|
|
22
32
|
- `flywheel_auth_status` (read; scopes: `read`; HTTP: `GET /auth/status`; core surface): Return Flywheel auth status for the current access token.
|
|
23
33
|
- `flywheel_get_credits_balance` (read; scopes: `read`; HTTP: `GET /credits`; core surface): Return current user credits balance and lifetime counters.
|
|
24
|
-
- `flywheel_updates_list` (read; scopes: `read`; HTTP: `
|
|
25
|
-
- `flywheel_updates_hide` (mutating; scopes: `write`; HTTP: `POST /
|
|
26
|
-
- `flywheel_updates_hide_all_active` (mutating; scopes: `write`; HTTP: `POST /
|
|
27
|
-
- `flywheel_updates_unhide` (mutating; scopes: `write`; HTTP: `DELETE /
|
|
28
|
-
- `flywheel_list_nodes` (read; scopes: `read`; HTTP: `GET /
|
|
29
|
-
- `flywheel_resolve_node_slug` (read; scopes: `read`; HTTP: `GET /
|
|
30
|
-
- `flywheel_get_node_sharing` (read; scopes: `read`; HTTP: `
|
|
31
|
-
- `flywheel_set_sharing_for_node` (mutating; scopes: `write`; HTTP: `
|
|
32
|
-
- `flywheel_set_sharing_for_nodes` (mutating; scopes: `write`; HTTP: `POST /
|
|
33
|
-
- `flywheel_get_node` (read; scopes: `read`; HTTP: `
|
|
34
|
-
- `flywheel_create_node_tag` (mutating; scopes: `write`; HTTP: `POST /
|
|
35
|
-
- `flywheel_update_node_tag` (mutating; scopes: `write`; HTTP: `PATCH /
|
|
36
|
-
- `flywheel_delete_node_tag` (mutating; scopes: `write`; HTTP: `DELETE /
|
|
37
|
-
- `flywheel_set_node_tag_assignments` (mutating; scopes: `write`; HTTP: `PUT /
|
|
38
|
-
- `flywheel_get_node_tree` (read; scopes: `read`; HTTP: `GET /
|
|
39
|
-
- `flywheel_get_node_ancestry` (read; scopes: `read`; HTTP: `GET /
|
|
40
|
-
- `flywheel_get_campaign_snapshot` (read; scopes: `read`; HTTP: `GET /
|
|
41
|
-
- `flywheel_list_audit` (read; scopes: `read`; HTTP: `GET /
|
|
34
|
+
- `flywheel_updates_list` (read; scopes: `read`; HTTP: `tool-mediated`; core surface): List in-app updates/announcements for the signed-in user.
|
|
35
|
+
- `flywheel_updates_hide` (mutating; scopes: `write`; HTTP: `POST /updates/{announcement_id}/hide`; core surface): Mark one update as hidden for the current user (Don't show again).
|
|
36
|
+
- `flywheel_updates_hide_all_active` (mutating; scopes: `write`; HTTP: `POST /updates/hide-all-active`; core surface): Hide all active updates for the current user (Don't show all active again).
|
|
37
|
+
- `flywheel_updates_unhide` (mutating; scopes: `write`; HTTP: `DELETE /updates/{announcement_id}/hide`; core surface): Restore one hidden update for the current user.
|
|
38
|
+
- `flywheel_list_nodes` (read; scopes: `read`; HTTP: `GET /nodes`; full-surface only): List nodes with optional owners/writers/visibility filters and projection control (`core`, `topology`, `full`).
|
|
39
|
+
- `flywheel_resolve_node_slug` (read; scopes: `read`; HTTP: `GET /nodes/resolve-by-slug`; core surface): Resolve a node by slug_name with explicit conflict handling (`unique`, `context_resolved`, `ambiguous`, `not_found`).
|
|
40
|
+
- `flywheel_get_node_sharing` (read; scopes: `read`; HTTP: `tool-mediated`; full-surface only): Get node sharing for one node (owner/collaborators/visibility).
|
|
41
|
+
- `flywheel_set_sharing_for_node` (mutating; scopes: `write`; HTTP: `tool-mediated`; full-surface only): Set sharing for one owned node (collaborators/private-unlisted-public visibility).
|
|
42
|
+
- `flywheel_set_sharing_for_nodes` (mutating; scopes: `write`; HTTP: `POST /nodes/access-policy/bulk`; full-surface only): Apply one sharing configuration across multiple owned nodes in bulk.
|
|
43
|
+
- `flywheel_get_node` (read; scopes: `read`; HTTP: `tool-mediated`; core surface): Get one node by node_id.
|
|
44
|
+
- `flywheel_create_node_tag` (mutating; scopes: `write`; HTTP: `POST /nodes/{root_node_id}/tags`; full-surface only): Create one graph tag from a root node. `track_history` is effective only when `one_only=true`; when `one_only=false`, the effective track_history=false.
|
|
45
|
+
- `flywheel_update_node_tag` (mutating; scopes: `write`; HTTP: `PATCH /nodes/{root_node_id}/tags/{tag_id}`; full-surface only): Update one graph tag from a root node.
|
|
46
|
+
- `flywheel_delete_node_tag` (mutating; scopes: `write`; HTTP: `DELETE /nodes/{root_node_id}/tags/{tag_id}`; full-surface only): Delete one graph tag from a root node.
|
|
47
|
+
- `flywheel_set_node_tag_assignments` (mutating; scopes: `write`; HTTP: `PUT /nodes/{node_id}/tags`; full-surface only): Set graph tag assignments for one node (`tag_ids` must be a JSON array of strings; omit `tag_ids` to clear all assignments to `[]`).
|
|
48
|
+
- `flywheel_get_node_tree` (read; scopes: `read`; HTTP: `GET /nodes/{node_id}/tree`; full-surface only): Get a root-aware bounded tree/DAG projection for an anchor node.
|
|
49
|
+
- `flywheel_get_node_ancestry` (read; scopes: `read`; HTTP: `GET /nodes/{node_id}/ancestry`; full-surface only): Get ordered ancestry metadata from an anchor node to root boundaries.
|
|
50
|
+
- `flywheel_get_campaign_snapshot` (read; scopes: `read`; HTTP: `GET /nodes/{node_id}/campaign/snapshot`; core surface): Read the current campaign snapshot for a node's root campaign, including configured views and derived records.
|
|
51
|
+
- `flywheel_list_audit` (read; scopes: `read`; HTTP: `GET /nodes/{node_id}/audit`; full-surface only): List node MCP audit events.
|
|
42
52
|
|
|
43
53
|
### Node stage and commit
|
|
44
54
|
|
|
45
|
-
- `flywheel_commit_new_node` (mutating; scopes: `write`; HTTP: `POST /
|
|
46
|
-
- `flywheel_acquire_stage_lease` (mutating; scopes: `write`; HTTP: `POST /
|
|
47
|
-
- `flywheel_heartbeat_stage_lease` (mutating; scopes: `write`; HTTP: `POST /
|
|
48
|
-
- `flywheel_release_stage_lease` (mutating; scopes: `write`; HTTP: `POST /
|
|
49
|
-
- `flywheel_commit_node` (mutating; scopes: `write`; HTTP: `POST /
|
|
50
|
-
- `flywheel_branch_node` (mutating; scopes: `write`; HTTP: `POST /
|
|
51
|
-
- `flywheel_merge_nodes` (mutating; scopes: `write`; HTTP: `POST /
|
|
52
|
-
- `flywheel_add_parent` (mutating; scopes: `write`; HTTP: `POST /
|
|
53
|
-
- `flywheel_remove_parent` (mutating; scopes: `write`; HTTP: `POST /
|
|
54
|
-
- `flywheel_delete_node` (mutating; scopes: `write`; HTTP: `DELETE /
|
|
55
|
-
- `flywheel_bulk_delete_nodes` (mutating; scopes: `write`; HTTP: `POST /
|
|
55
|
+
- `flywheel_commit_new_node` (mutating; scopes: `write`; HTTP: `POST /nodes/commit-new`; full-surface only): Commit a locally staged new node into canonical storage and return the persisted node.
|
|
56
|
+
- `flywheel_acquire_stage_lease` (mutating; scopes: `write`; HTTP: `POST /nodes/{node_id}/stage/lease/acquire`; full-surface only): Acquire a session-scoped stage lease for an existing node before local staged edits.
|
|
57
|
+
- `flywheel_heartbeat_stage_lease` (mutating; scopes: `write`; HTTP: `POST /nodes/{node_id}/stage/lease/heartbeat`; full-surface only): Refresh the active stage lease for the current editing session.
|
|
58
|
+
- `flywheel_release_stage_lease` (mutating; scopes: `write`; HTTP: `POST /nodes/{node_id}/stage/lease/release`; full-surface only): Release the active stage lease for the current editing session.
|
|
59
|
+
- `flywheel_commit_node` (mutating; scopes: `write`; HTTP: `POST /nodes/{node_id}/commit`; core surface): Commit an existing node by publishing the caller's staged payload under an active stage lease.
|
|
60
|
+
- `flywheel_branch_node` (mutating; scopes: `write`; HTTP: `POST /nodes/{node_id}/branch`; full-surface only): Create a child branch node with optimistic locking (`expected_revision` required).
|
|
61
|
+
- `flywheel_merge_nodes` (mutating; scopes: `write`; HTTP: `POST /nodes/merge`; full-surface only): Merge nodes with caller-resolved node payload.
|
|
62
|
+
- `flywheel_add_parent` (mutating; scopes: `write`; HTTP: `POST /nodes/{node_id}/parents/add`; full-surface only): Attach an additional parent edge to an existing node (keeps node identity, validates against cycles).
|
|
63
|
+
- `flywheel_remove_parent` (mutating; scopes: `write`; HTTP: `POST /nodes/{node_id}/parents/remove`; full-surface only): Detach one parent edge from a node without deleting the node.
|
|
64
|
+
- `flywheel_delete_node` (mutating; scopes: `write`; HTTP: `DELETE /nodes/{node_id}`; full-surface only): Delete a node and its descendants. Modes: `cascade` (delete full subtree), `detach_shared` (preserve descendants with surviving parents).
|
|
65
|
+
- `flywheel_bulk_delete_nodes` (mutating; scopes: `write`; HTTP: `POST /nodes/bulk-delete`; full-surface only): Delete multiple node subtrees in one operation.
|
|
56
66
|
|
|
57
67
|
### Artifacts
|
|
58
68
|
|
|
59
|
-
- `flywheel_prepare_artifact_uploads` (mutating; scopes: `write`; HTTP: `POST /
|
|
60
|
-
- `flywheel_finalize_artifact_uploads` (mutating; scopes: `write`; HTTP: `POST /
|
|
61
|
-
- `flywheel_list_artifacts` (read; scopes: `read`; HTTP: `
|
|
62
|
-
- `flywheel_get_artifact` (read; scopes: `read`; HTTP: `
|
|
63
|
-
- `flywheel_delete_artifact` (mutating; scopes: `write`; HTTP: `DELETE /
|
|
64
|
-
- `flywheel_set_artifact_note` (mutating; scopes: `write`; HTTP: `PATCH /
|
|
69
|
+
- `flywheel_prepare_artifact_uploads` (mutating; scopes: `write`; HTTP: `POST /nodes/{node_id}/artifacts/uploads/prepare`; core surface): Prepare one or more raw-file artifact uploads (returns batch token + signed upload URLs). Upload must send raw file bytes to the returned URLs (do not upload JSON metadata wrappers).
|
|
70
|
+
- `flywheel_finalize_artifact_uploads` (mutating; scopes: `write`; HTTP: `POST /nodes/{node_id}/artifacts/uploads/finalize`; core surface): Finalize a prepared artifact upload batch and append all staged artifacts to the node in one revision bump.
|
|
71
|
+
- `flywheel_list_artifacts` (read; scopes: `read`; HTTP: `tool-mediated`; core surface): List node artifacts.
|
|
72
|
+
- `flywheel_get_artifact` (read; scopes: `read`; HTTP: `tool-mediated`; core surface): Get one artifact by id.
|
|
73
|
+
- `flywheel_delete_artifact` (mutating; scopes: `write`; HTTP: `DELETE /nodes/{node_id}/artifacts/{artifact_id}`; core surface): Delete one artifact by id with optimistic locking.
|
|
74
|
+
- `flywheel_set_artifact_note` (mutating; scopes: `write`; HTTP: `PATCH /nodes/{node_id}/artifacts/{artifact_id}/note`; core surface): Set or clear one artifact note with optimistic locking.
|
|
65
75
|
|
|
66
76
|
### Executions
|
|
67
77
|
|
|
68
|
-
- `flywheel_launch_execution` (mutating; scopes: `write`; HTTP: `POST /
|
|
69
|
-
- `flywheel_list_executions` (read; scopes: `read`; HTTP: `GET /
|
|
70
|
-
- `flywheel_terminate_execution` (mutating; scopes: `write`; HTTP: `POST /
|
|
78
|
+
- `flywheel_launch_execution` (mutating; scopes: `write`; HTTP: `POST /nodes/{node_id}/executions`; core surface): Launch node execution.
|
|
79
|
+
- `flywheel_list_executions` (read; scopes: `read`; HTTP: `GET /nodes/{node_id}/executions`; core surface): List node executions.
|
|
80
|
+
- `flywheel_terminate_execution` (mutating; scopes: `write`; HTTP: `POST /nodes/{node_id}/executions/{execution_id}/terminate`; core surface): Terminate a node execution.
|
|
71
81
|
|
|
72
82
|
### Compute and budgets
|
|
73
83
|
|
|
74
|
-
- `flywheel_compute_list_options` (read; scopes: `compute`; HTTP: `GET /
|
|
75
|
-
- `
|
|
76
|
-
- `
|
|
77
|
-
- `
|
|
78
|
-
- `
|
|
79
|
-
- `
|
|
84
|
+
- `flywheel_compute_list_options` (read; scopes: `compute`; HTTP: `GET /compute/catalog`; core surface): List managed compute options allowed for a node. When using grant-backed compute, pass the same compute_grant_id you will use for acquire.
|
|
85
|
+
- `flywheel_compute_funding` (read; scopes: `compute`; HTTP: `GET /compute/funding`; core surface): Read grant-scoped funding context (`grant_cents`, `remaining_cents`, and backing budget fields) for a `compute_grant_id` before compute acquire.
|
|
86
|
+
- `flywheel_compute_status` (read; scopes: `compute`; HTTP: `GET /compute/status`; core surface): Read managed compute lease status for the current user and current lease_control_token scope. Lease rows include ownership flags so hosts can distinguish user-owned leases from sponsor-visible campaign leases. When checking a grant-backed lease, reuse the same compute_grant_id passed to acquire.
|
|
87
|
+
- `flywheel_compute_connection` (read; scopes: `compute`; HTTP: `GET /compute/connection`; core surface): Read SSH connection material for an active managed compute lease once flywheel_compute_status indicates the lease is usable. This tool is token-scoped to lease_control_token and only leases owned by the current user are connectable. Pass lease_id or node_id to disambiguate when needed.
|
|
88
|
+
- `flywheel_approval_session_heartbeat` (read; scopes: `compute`; HTTP: `POST /approval-sessions/heartbeat`; core surface): Create or refresh a compute-grant approval session for the current MCP host session.
|
|
89
|
+
- `flywheel_list_approval_sessions` (read; scopes: `compute`; HTTP: `GET /approval-sessions`; core surface): List approval sessions visible to the current user.
|
|
90
|
+
- `flywheel_expire_approval_session` (mutating; scopes: `compute`; HTTP: `POST /approval-sessions/expire`; core surface): Expire the current compute-grant approval session context without releasing active leases.
|
|
80
91
|
- `flywheel_request_compute_grant_approval` (mutating; scopes: `compute`; HTTP: `tool-mediated`; core surface): Request budget approval context before managed compute acquisition; branch on response status.
|
|
81
|
-
- `flywheel_list_compute_grants` (read; scopes: `compute`; HTTP: `GET /
|
|
82
|
-
- `flywheel_list_campaign_budgets` (read; scopes: `compute`; HTTP: `GET /
|
|
83
|
-
- `flywheel_create_campaign_budget` (mutating; scopes: `compute`; HTTP: `POST /
|
|
84
|
-
- `flywheel_update_campaign_budget` (mutating; scopes: `compute`; HTTP: `PATCH /
|
|
85
|
-
- `flywheel_revoke_campaign_budget` (mutating; scopes: `compute`; HTTP: `DELETE /
|
|
92
|
+
- `flywheel_list_compute_grants` (read; scopes: `compute`; HTTP: `GET /compute/grants`; core surface): List active/exhausted compute grants available to the current user.
|
|
93
|
+
- `flywheel_list_campaign_budgets` (read; scopes: `compute`; HTTP: `GET /nodes/{root_node_id}/campaign-budgets`; full-surface only): List campaign compute budgets for a campaign root. Organizer-only management view.
|
|
94
|
+
- `flywheel_create_campaign_budget` (mutating; scopes: `compute`; HTTP: `POST /nodes/{root_node_id}/campaign-budgets`; full-surface only): Create an organizer-funded campaign compute budget shared with participants.
|
|
95
|
+
- `flywheel_update_campaign_budget` (mutating; scopes: `compute`; HTTP: `PATCH /nodes/{root_node_id}/campaign-budgets/{compute_budget_id}`; full-surface only): Update hard caps or metadata for an organizer-funded campaign compute budget.
|
|
96
|
+
- `flywheel_revoke_campaign_budget` (mutating; scopes: `compute`; HTTP: `DELETE /nodes/{root_node_id}/campaign-budgets/{compute_budget_id}`; full-surface only): Revoke an organizer-funded campaign compute budget.
|
|
86
97
|
- `flywheel_compute_acquire` (mutating; scopes: `compute`; HTTP: `tool-mediated`; core surface): Acquire managed compute for a node with explicit SKU + region and required compute_grant_id (returns accepted/completed lease state only; poll flywheel_compute_status for readiness, not SSH key material). This tool forwards approval_session_id.
|
|
87
|
-
- `flywheel_compute_release` (mutating; scopes: `compute`; HTTP: `
|
|
88
|
-
- `flywheel_compute_release_all` (mutating; scopes: `compute`; HTTP: `
|
|
98
|
+
- `flywheel_compute_release` (mutating; scopes: `compute`; HTTP: `tool-mediated`; core surface): Asynchronously release one managed compute lease by lease_id within the current lease_control_token scope.
|
|
99
|
+
- `flywheel_compute_release_all` (mutating; scopes: `compute`; HTTP: `tool-mediated`; core surface): Asynchronously release active managed compute leases in the current lease_control_token scope; set force=true for explicit account-wide cleanup for the current user.
|
|
89
100
|
|
|
90
101
|
### Contract, audit, and export
|
|
91
102
|
|
|
92
103
|
- `flywheel_get_contract` (read; scopes: `read`; HTTP: `GET /mcp/contract`; core surface): Return Flywheel MCP contract overview (scopes, write safety, operation catalog, and section index).
|
|
93
104
|
- `flywheel_get_contract_section` (read; scopes: `read`; HTTP: `GET /mcp/contract/sections/{section_id}`; core surface): Return one contract section by section_id (for example `graph` or `campaign/template_v1`).
|
|
94
|
-
- `flywheel_export_subgraph` (read; scopes: `read`; HTTP: `POST /
|
|
95
|
-
- `flywheel_import_subgraph` (mutating; scopes: `write`; HTTP: `POST /
|
|
96
|
-
- `flywheel_summarize_node_tree` (read; scopes: `read`; HTTP: `GET /
|
|
97
|
-
- `flywheel_export_summary` (read; scopes: `read`; HTTP: `POST /
|
|
98
|
-
- `flywheel_export_summary_stream` (read; scopes: `read`; HTTP: `POST /
|
|
99
|
-
- `flywheel_export_summary_pdf` (read; scopes: `read`; HTTP: `POST /
|
|
100
|
-
- `flywheel_export_summary_render_pdf` (read; scopes: `read`; HTTP: `POST /
|
|
105
|
+
- `flywheel_export_subgraph` (read; scopes: `read`; HTTP: `POST /export`; full-surface only): Export selected graph/subgraph nodes as JSON.
|
|
106
|
+
- `flywheel_import_subgraph` (mutating; scopes: `write`; HTTP: `POST /import`; full-surface only): Import graph/subgraph JSON payload into new node IDs. Set normalize_cycles=true to drop cycle/self-loop edges; default rejects cyclic payloads.
|
|
107
|
+
- `flywheel_summarize_node_tree` (read; scopes: `read`; HTTP: `GET /nodes/{node_id}/summary`; full-surface only): Summarize a node tree using node fields only.
|
|
108
|
+
- `flywheel_export_summary` (read; scopes: `read`; HTTP: `POST /export-summary`; full-surface only): Generate markdown summary for selected nodes.
|
|
109
|
+
- `flywheel_export_summary_stream` (read; scopes: `read`; HTTP: `POST /export-summary-stream`; full-surface only): Generate summary stream events for selected nodes.
|
|
110
|
+
- `flywheel_export_summary_pdf` (read; scopes: `read`; HTTP: `POST /export-summary-pdf`; full-surface only): Generate PDF summary for selected nodes.
|
|
111
|
+
- `flywheel_export_summary_render_pdf` (read; scopes: `read`; HTTP: `POST /export-summary-render-pdf`; full-surface only): Render provided markdown to PDF and embed export metadata.
|
|
101
112
|
|
|
102
113
|
## Practical Tool Sequences
|
|
103
114
|
|
|
@@ -133,11 +144,14 @@ Flywheel is a graph-based system for tracking research work, decisions, and evid
|
|
|
133
144
|
- `flywheel_acquire_stage_lease`, `flywheel_heartbeat_stage_lease`, `flywheel_release_stage_lease`: coordinate session-scoped local staged edits for an existing node before commit.
|
|
134
145
|
- `flywheel_get_campaign_snapshot`: read the current derived campaign state for this node's root campaign instead of inferring standings from freeform text.
|
|
135
146
|
- `flywheel_get_node_sharing`: after sharing writes, verify with flywheel_get_node_sharing before reporting private/shared/public state.
|
|
147
|
+
- `flywheel_set_node_tag_assignments`: pass `tag_ids` as a JSON array of strings; omitting `tag_ids` clears all assignments (`[]`).
|
|
148
|
+
- `flywheel_list_nodes`: canonical filter inputs for `owners`, `writers`, and `visibility` are arrays; scalar `owners`/`writers` may be normalized by transport compatibility layers, but array form is preferred.
|
|
136
149
|
- `flywheel_compute_status`: check first when work may need managed compute (GPU), using the active lease_control_token from host context (or pass it explicitly).
|
|
137
150
|
- `flywheel_list_compute_grants`: list active compute grants (funded by user/root budgets) and select one `compute_grant_id` for acquisition.
|
|
138
151
|
- `flywheel_request_compute_grant_approval`: request/confirm budget before acquire and choose a budget source (`user` or `root`); branch on status (`already_approved`, `approval_required`, `insufficient_credits`).
|
|
139
152
|
- `flywheel_compute_connection`: read SSH connection material for the active user lease once status indicates the lease is usable, scoped by lease_control_token.
|
|
140
|
-
- `flywheel_compute_list_options`: use when a lease is needed and no suitable active lease exists, then select explicit provider-qualified `offer_id` (`provider::offer_id`) and `region`.
|
|
153
|
+
- `flywheel_compute_list_options`: use when a lease is needed and no suitable active lease exists, then select explicit provider-qualified `offer_id` (`provider::offer_id`) and `region`. This is a catalog-only read and excludes grant/budget money fields.
|
|
154
|
+
- `flywheel_compute_funding`: read grant-scoped funding context (`grant_cents`, `remaining_cents`, backing budget fields) for the selected `compute_grant_id` before acquire.
|
|
141
155
|
- `flywheel_compute_acquire`: provision compute once requirements are clear. This requires a valid `compute_grant_id` and returns lease/provisioning state only (not SSH key material). Capture `compute.lease_control_token` from the response for follow-up lease control tools.
|
|
142
156
|
- `flywheel_compute_release`: release compute when no longer needed, scoped by lease_control_token.
|
|
143
157
|
- `flywheel_launch_execution`, `flywheel_list_executions`, `flywheel_terminate_execution`: manage execution status transitions.
|
|
@@ -13,6 +13,14 @@ Use it when converting theorem-heavy source material into Lean modules, iteratin
|
|
|
13
13
|
|
|
14
14
|
## Prerequisite (Required)
|
|
15
15
|
|
|
16
|
+
As the very first thing, you MUST use the plan tool to create a task list with checkmarks for all the workflow steps that follow.
|
|
17
|
+
|
|
18
|
+
- If you are a codex model, use `update_plan`.
|
|
19
|
+
- If you are a claude model, use `TaskCreate`.
|
|
20
|
+
- If you are another model/harness, use an equivalent.
|
|
21
|
+
|
|
22
|
+
Include the following pre-requisite in the checkmark list.
|
|
23
|
+
|
|
16
24
|
Before running the pipeline, ensure both `uv` and the Lean toolchain manager `elan` are installed on the local machine.
|
|
17
25
|
|
|
18
26
|
- If `uv` is missing, bootstrap it by OS:
|
|
@@ -63,8 +63,8 @@ Before execution, recover or establish these inputs:
|
|
|
63
63
|
branch planning or execution.
|
|
64
64
|
4. Map each stable page, claim, or concept to a node.
|
|
65
65
|
- For exact node-mutation shapes, load [references/flywheel-mcp-tool-map.md](references/flywheel-mcp-tool-map.md).
|
|
66
|
-
- Create a new node with `
|
|
67
|
-
- Update an existing node with `flywheel_get_node` + `
|
|
66
|
+
- Create a new node with `flywheel_commit_new_node` when needed.
|
|
67
|
+
- Update an existing node with `flywheel_get_node` + `flywheel_acquire_stage_lease` + `flywheel_commit_node` when continuing work.
|
|
68
68
|
5. Put the primary page markdown or validation rationale in the node body/readme field (`content`).
|
|
69
69
|
- Keep `summary` concise.
|
|
70
70
|
- Populate `hypothesis`, `insights`, `outcome`, and similar fields only when the source actually supports them.
|
|
@@ -111,11 +111,11 @@ For the canonical entity model and public contract terminology behind this contr
|
|
|
111
111
|
|
|
112
112
|
Use this storage convention:
|
|
113
113
|
|
|
114
|
-
1. Reuse an existing control node when one already governs the same source or claim family; otherwise create one with `
|
|
114
|
+
1. Reuse an existing control node when one already governs the same source or claim family; otherwise create one with `flywheel_commit_new_node`.
|
|
115
115
|
2. Put the canonical contract in node `content`.
|
|
116
116
|
3. Put a one-line synopsis in `summary`.
|
|
117
117
|
4. Put the validation rationale, branch-priority logic, or continuation rule in `insights` so the `insight` commit contract is satisfied.
|
|
118
|
-
5.
|
|
118
|
+
5. Before committing control-node edits, acquire or refresh the stage lease with `flywheel_acquire_stage_lease` (and `flywheel_heartbeat_stage_lease` for long edits).
|
|
119
119
|
6. Read the control node with `flywheel_get_node` before later passes that need a fresh `expected_revision`.
|
|
120
120
|
7. Commit the control node with `flywheel_commit_node` once the contract is coherent, even if downstream validation branches remain staged or in progress.
|
|
121
121
|
|
|
@@ -12,7 +12,7 @@ Canonical artifact upload/finalize contract derived from `mcp_contract.py`.
|
|
|
12
12
|
- Upload body contract: `raw_file_bytes`.
|
|
13
13
|
- Prepare item required fields: `artifact_type`, `filename`, `media_type`.
|
|
14
14
|
- Prepare item optional fields: `title`, `execution_id`, `metadata`, `note`.
|
|
15
|
-
- Prepare item note: prepare.items[] is structured object input
|
|
15
|
+
- Prepare item note: prepare.items[] is structured object input. The transport layer may tolerate stringified JSON as a compatibility measure; this tolerance is not contractual and may be removed.
|
|
16
16
|
- Raw upload stage success code: `202`.
|
|
17
17
|
- Stage semantics: `accepted_and_staged`.
|
|
18
18
|
- Finalize appends the batch with a single revision bump: `True`.
|
|
@@ -82,6 +82,7 @@ Canonical reference for Flywheel MCP public interfaces and contract pointers.
|
|
|
82
82
|
### Compute and budgets
|
|
83
83
|
|
|
84
84
|
- `flywheel_compute_list_options` (read; scopes: `compute`; core surface; binding: `operation`)
|
|
85
|
+
- `flywheel_compute_funding` (read; scopes: `compute`; core surface; binding: `operation`)
|
|
85
86
|
- `flywheel_compute_status` (read; scopes: `compute`; core surface; binding: `operation`)
|
|
86
87
|
- `flywheel_compute_connection` (read; scopes: `compute`; core surface; binding: `operation`)
|
|
87
88
|
- `flywheel_approval_session_heartbeat` (read; scopes: `compute`; core surface; binding: `operation`)
|
|
@@ -115,83 +116,84 @@ Canonical reference for Flywheel MCP public interfaces and contract pointers.
|
|
|
115
116
|
|
|
116
117
|
- `GET /auth/status` -> `flywheel_auth_status`
|
|
117
118
|
- `GET /credits` -> `flywheel_get_credits_balance`
|
|
118
|
-
- `
|
|
119
|
-
- `POST /
|
|
120
|
-
- `POST /
|
|
121
|
-
- `DELETE /
|
|
122
|
-
- `GET /
|
|
123
|
-
- `GET /
|
|
124
|
-
- `
|
|
125
|
-
- `
|
|
126
|
-
- `POST /
|
|
127
|
-
- `
|
|
128
|
-
- `POST /
|
|
129
|
-
- `PATCH /
|
|
130
|
-
- `DELETE /
|
|
131
|
-
- `PUT /
|
|
132
|
-
- `GET /
|
|
133
|
-
- `GET /
|
|
134
|
-
- `GET /
|
|
135
|
-
- `GET /
|
|
119
|
+
- `tool-mediated` -> `flywheel_updates_list`
|
|
120
|
+
- `POST /updates/{announcement_id}/hide` -> `flywheel_updates_hide`
|
|
121
|
+
- `POST /updates/hide-all-active` -> `flywheel_updates_hide_all_active`
|
|
122
|
+
- `DELETE /updates/{announcement_id}/hide` -> `flywheel_updates_unhide`
|
|
123
|
+
- `GET /nodes` -> `flywheel_list_nodes`
|
|
124
|
+
- `GET /nodes/resolve-by-slug` -> `flywheel_resolve_node_slug`
|
|
125
|
+
- `tool-mediated` -> `flywheel_get_node_sharing`
|
|
126
|
+
- `tool-mediated` -> `flywheel_set_sharing_for_node`
|
|
127
|
+
- `POST /nodes/access-policy/bulk` -> `flywheel_set_sharing_for_nodes`
|
|
128
|
+
- `tool-mediated` -> `flywheel_get_node`
|
|
129
|
+
- `POST /nodes/{root_node_id}/tags` -> `flywheel_create_node_tag`
|
|
130
|
+
- `PATCH /nodes/{root_node_id}/tags/{tag_id}` -> `flywheel_update_node_tag`
|
|
131
|
+
- `DELETE /nodes/{root_node_id}/tags/{tag_id}` -> `flywheel_delete_node_tag`
|
|
132
|
+
- `PUT /nodes/{node_id}/tags` -> `flywheel_set_node_tag_assignments`
|
|
133
|
+
- `GET /nodes/{node_id}/tree` -> `flywheel_get_node_tree`
|
|
134
|
+
- `GET /nodes/{node_id}/ancestry` -> `flywheel_get_node_ancestry`
|
|
135
|
+
- `GET /nodes/{node_id}/campaign/snapshot` -> `flywheel_get_campaign_snapshot`
|
|
136
|
+
- `GET /nodes/{node_id}/audit` -> `flywheel_list_audit`
|
|
136
137
|
|
|
137
138
|
### Node stage and commit
|
|
138
139
|
|
|
139
|
-
- `POST /
|
|
140
|
-
- `POST /
|
|
141
|
-
- `POST /
|
|
142
|
-
- `POST /
|
|
143
|
-
- `POST /
|
|
144
|
-
- `POST /
|
|
145
|
-
- `POST /
|
|
146
|
-
- `POST /
|
|
147
|
-
- `POST /
|
|
148
|
-
- `DELETE /
|
|
149
|
-
- `POST /
|
|
140
|
+
- `POST /nodes/commit-new` -> `flywheel_commit_new_node`
|
|
141
|
+
- `POST /nodes/{node_id}/stage/lease/acquire` -> `flywheel_acquire_stage_lease`
|
|
142
|
+
- `POST /nodes/{node_id}/stage/lease/heartbeat` -> `flywheel_heartbeat_stage_lease`
|
|
143
|
+
- `POST /nodes/{node_id}/stage/lease/release` -> `flywheel_release_stage_lease`
|
|
144
|
+
- `POST /nodes/{node_id}/commit` -> `flywheel_commit_node`
|
|
145
|
+
- `POST /nodes/{node_id}/branch` -> `flywheel_branch_node`
|
|
146
|
+
- `POST /nodes/merge` -> `flywheel_merge_nodes`
|
|
147
|
+
- `POST /nodes/{node_id}/parents/add` -> `flywheel_add_parent`
|
|
148
|
+
- `POST /nodes/{node_id}/parents/remove` -> `flywheel_remove_parent`
|
|
149
|
+
- `DELETE /nodes/{node_id}` -> `flywheel_delete_node`
|
|
150
|
+
- `POST /nodes/bulk-delete` -> `flywheel_bulk_delete_nodes`
|
|
150
151
|
|
|
151
152
|
### Artifacts
|
|
152
153
|
|
|
153
|
-
- `POST /
|
|
154
|
-
- `POST /
|
|
155
|
-
- `
|
|
156
|
-
- `
|
|
157
|
-
- `DELETE /
|
|
158
|
-
- `PATCH /
|
|
154
|
+
- `POST /nodes/{node_id}/artifacts/uploads/prepare` -> `flywheel_prepare_artifact_uploads`
|
|
155
|
+
- `POST /nodes/{node_id}/artifacts/uploads/finalize` -> `flywheel_finalize_artifact_uploads`
|
|
156
|
+
- `tool-mediated` -> `flywheel_list_artifacts`
|
|
157
|
+
- `tool-mediated` -> `flywheel_get_artifact`
|
|
158
|
+
- `DELETE /nodes/{node_id}/artifacts/{artifact_id}` -> `flywheel_delete_artifact`
|
|
159
|
+
- `PATCH /nodes/{node_id}/artifacts/{artifact_id}/note` -> `flywheel_set_artifact_note`
|
|
159
160
|
|
|
160
161
|
### Executions
|
|
161
162
|
|
|
162
|
-
- `POST /
|
|
163
|
-
- `GET /
|
|
164
|
-
- `POST /
|
|
163
|
+
- `POST /nodes/{node_id}/executions` -> `flywheel_launch_execution`
|
|
164
|
+
- `GET /nodes/{node_id}/executions` -> `flywheel_list_executions`
|
|
165
|
+
- `POST /nodes/{node_id}/executions/{execution_id}/terminate` -> `flywheel_terminate_execution`
|
|
165
166
|
|
|
166
167
|
### Compute and budgets
|
|
167
168
|
|
|
168
|
-
- `GET /
|
|
169
|
-
- `GET /
|
|
170
|
-
- `GET /
|
|
171
|
-
- `
|
|
172
|
-
- `
|
|
173
|
-
- `
|
|
169
|
+
- `GET /compute/catalog` -> `flywheel_compute_list_options`
|
|
170
|
+
- `GET /compute/funding` -> `flywheel_compute_funding`
|
|
171
|
+
- `GET /compute/status` -> `flywheel_compute_status`
|
|
172
|
+
- `GET /compute/connection` -> `flywheel_compute_connection`
|
|
173
|
+
- `POST /approval-sessions/heartbeat` -> `flywheel_approval_session_heartbeat`
|
|
174
|
+
- `GET /approval-sessions` -> `flywheel_list_approval_sessions`
|
|
175
|
+
- `POST /approval-sessions/expire` -> `flywheel_expire_approval_session`
|
|
174
176
|
- `tool-mediated` -> `flywheel_request_compute_grant_approval`
|
|
175
|
-
- `GET /
|
|
176
|
-
- `GET /
|
|
177
|
-
- `POST /
|
|
178
|
-
- `PATCH /
|
|
179
|
-
- `DELETE /
|
|
177
|
+
- `GET /compute/grants` -> `flywheel_list_compute_grants`
|
|
178
|
+
- `GET /nodes/{root_node_id}/campaign-budgets` -> `flywheel_list_campaign_budgets`
|
|
179
|
+
- `POST /nodes/{root_node_id}/campaign-budgets` -> `flywheel_create_campaign_budget`
|
|
180
|
+
- `PATCH /nodes/{root_node_id}/campaign-budgets/{compute_budget_id}` -> `flywheel_update_campaign_budget`
|
|
181
|
+
- `DELETE /nodes/{root_node_id}/campaign-budgets/{compute_budget_id}` -> `flywheel_revoke_campaign_budget`
|
|
180
182
|
- `tool-mediated` -> `flywheel_compute_acquire`
|
|
181
|
-
- `
|
|
182
|
-
- `
|
|
183
|
+
- `tool-mediated` -> `flywheel_compute_release`
|
|
184
|
+
- `tool-mediated` -> `flywheel_compute_release_all`
|
|
183
185
|
|
|
184
186
|
### Contract, audit, and export
|
|
185
187
|
|
|
186
188
|
- `GET /mcp/contract` -> `flywheel_get_contract`
|
|
187
189
|
- `GET /mcp/contract/sections/{section_id}` -> `flywheel_get_contract_section`
|
|
188
|
-
- `POST /
|
|
189
|
-
- `POST /
|
|
190
|
-
- `GET /
|
|
191
|
-
- `POST /
|
|
192
|
-
- `POST /
|
|
193
|
-
- `POST /
|
|
194
|
-
- `POST /
|
|
190
|
+
- `POST /export` -> `flywheel_export_subgraph`
|
|
191
|
+
- `POST /import` -> `flywheel_import_subgraph`
|
|
192
|
+
- `GET /nodes/{node_id}/summary` -> `flywheel_summarize_node_tree`
|
|
193
|
+
- `POST /export-summary` -> `flywheel_export_summary`
|
|
194
|
+
- `POST /export-summary-stream` -> `flywheel_export_summary_stream`
|
|
195
|
+
- `POST /export-summary-pdf` -> `flywheel_export_summary_pdf`
|
|
196
|
+
- `POST /export-summary-render-pdf` -> `flywheel_export_summary_render_pdf`
|
|
195
197
|
|
|
196
198
|
## Auth and Write Safety
|
|
197
199
|
|
|
@@ -128,9 +128,9 @@ Use an `insight` node to capture rationale, open questions, experiment shape, an
|
|
|
128
128
|
|
|
129
129
|
Typical flow:
|
|
130
130
|
|
|
131
|
-
1. `
|
|
132
|
-
2. `
|
|
133
|
-
3. `mcp__flywheel__flywheel_commit_node`
|
|
131
|
+
1. `mcp__flywheel__flywheel_commit_new_node`
|
|
132
|
+
2. `mcp__flywheel__flywheel_acquire_stage_lease` when refining an existing design node
|
|
133
|
+
3. `mcp__flywheel__flywheel_commit_node` once the design brief is coherent
|
|
134
134
|
|
|
135
135
|
### Execution layer
|
|
136
136
|
|
|
@@ -138,8 +138,8 @@ Only after the design gate passes, create or branch the `empirical` node for the
|
|
|
138
138
|
|
|
139
139
|
Typical flow:
|
|
140
140
|
|
|
141
|
-
1. `mcp__flywheel__flywheel_branch_node` or `
|
|
142
|
-
2. `
|
|
141
|
+
1. `mcp__flywheel__flywheel_branch_node` or `mcp__flywheel__flywheel_commit_new_node`
|
|
142
|
+
2. `mcp__flywheel__flywheel_acquire_stage_lease` + `mcp__flywheel__flywheel_commit_node` with the explicit run summary and the local question or hypothesis for that branch
|
|
143
143
|
3. `mcp__flywheel__flywheel_request_compute_grant_approval` only after the user accepts the design
|
|
144
144
|
4. `mcp__flywheel__flywheel_list_compute_grants(status=active, approval_session_id=<session_id>)` when you need to resolve the approved `compute_grant_id`
|
|
145
145
|
5. `mcp__flywheel__flywheel_compute_acquire` and related compute tools only when execution is actually needed
|