flow-codeblock-mcp
v0.3.26
Published
Flow Codeblock stdio MCP Server and Codex Skill for JavaScript execution and script management.
Maintainers
Readme
flow-codeblock-mcp
Local stdio MCP server and Codex Skill for Flow Codeblock. The MCP server calls the Flow Codeblock Rust REST API; it never executes user JavaScript on the user's computer. User code runs in the server's pinned Bun Supervisor.
Installation
The deployed Flow Codeblock service runs Bun 1.4.4. The local MCP server requires Bun 1.4.0 or newer:
bunx --bun [email protected]Required environment:
FLOW_CODEBLOCK_BASE_URL=https://qingcode.oalite.com
FLOW_CODEBLOCK_TOKEN=flow_xxx
# Optional default owner email for ownership operations
[email protected]
# Optional default owner name for first lock/claim
FLOW_CODEBLOCK_OWNER_NAME=Default OwnerFLOW_CODEBLOCK_BASE_URL is the deployed Flow Codeblock Rust API base URL and the base for returned call URLs. Non-script tools return ${FLOW_CODEBLOCK_BASE_URL}/flow/codeblock as execution_url; script create, update, and execution tools return ${FLOW_CODEBLOCK_BASE_URL}/flow/codeblock/{script_id} as script_url. Other management tools do not return a call URL. Use https://qingcode.oalite.com for the public service, or the matching localhost URL for a local Rust deployment. Store the token in the client's environment or secret manager; never put it in prompts, tool arguments, or public files.
When FLOW_CODEBLOCK_OWNER_EMAIL is configured, current-owner email arguments for challenge, lock, unlock, release, and transfer authorization may be omitted. Explicit arguments win. The new owner email in a transfer confirmation is always required. When FLOW_CODEBLOCK_OWNER_NAME is configured, flow_lock_script.owner_name may be omitted; new_owner_name in transfers is always required.
Generic stdio configuration
{
"mcpServers": {
"flow-codeblock": {
"command": "bunx",
"args": ["--bun", "[email protected]"],
"env": {
"FLOW_CODEBLOCK_BASE_URL": "https://qingcode.oalite.com",
"FLOW_CODEBLOCK_TOKEN": "<YOUR_FLOW_CODEBLOCK_TOKEN>",
"FLOW_CODEBLOCK_OWNER_EMAIL": "[email protected]",
"FLOW_CODEBLOCK_OWNER_NAME": "Default Owner"
}
}
}
}The npm package includes the MCP runtime, the flow-codeblock Skill, AGENT_PROMPT.md, the default module blacklist snapshot, dangerous-pattern rules, and interface-document Schemas. The default snapshot is guidance; the running Flow Codeblock service remains authoritative after startup configuration changes. Ordinary MCP clients do not install the Codex Skill automatically; flow_write_code reads the packaged authoring, module-blacklist, and dangerous-pattern rules at runtime and returns them.
Calling rules
- Call
flow_write_codebefore writing code. Non-script code readsinput.<field>; script code readsinput.query/header/body/cookiesinternally. - After every non-script generation, fix, or update, return the complete latest JavaScript source; never return only a patch, fragment, explanation, or execution result.
- Script changes require
flow_preview_script_change, display of the successful preview, explicit user confirmation, and thenflow_apply_script_change. Code-only updates may omitinterface_docandinterface_doc_patch, preserving the current interface document. A successful preview already contains all normalizations and does not need a second preview. - Use
flow_get_scriptwith onlyscript_idfor the current version. Use history tools only for an explicitly requested version. The MCP server decodes validcode_base64to UTF-8code. - POST script execution receives the caller's business JSON directly as
body; do not wrap it ininputorinput.body. - Third-party API keys are business inputs supplied through the documented body, query, or business headers. User code must not read
process.env;FLOW_CODEBLOCK_TOKENis platform authentication only. - In
interface_doc.usage_refs,app_name,app_id,location, andnoteare strings; quote numeric-looking IDs such as"98701". - All JSON outputs recursively redact credential fields such as
token,access_token,authorization,refresh_token, andqingcodeToken. Statistics such astoken_cacheandunique_tokensare not credentials. - Release ownership by requesting a
releasechallenge first, then using the same script, email, and code; the script must be unlocked. MCP has no deletion tool. Deletion requires the web UI or REST API after unlock and ownership release. - Execution performs a read-only quota gate before running user code. Each count/hybrid gate reads the current MySQL balance and
quota_reset_version; Redis is preferred only when the snapshot is valid and its version matches that MySQL generation. Otherwise the MySQL balance is used; storage failures fail closed with HTTP 503. After code completes, the accounting task must be committed to the MySQL outbox before the original result is returned. The worker settles quota and statistics asynchronously and idempotently; an outbox persistence failure returns HTTP 503 withexecution_completed:true,accounting_persistence:"unconfirmed", andretryable:false, so clients must not retry automatically. Concurrent executions may drive the balance negative; quota responses preserve negativeremaining_quota, whileconsumed_quotais never below0and may exceedtotal_quota; later calls return HTTP 429 when the observed balance is not positive. - Invalid quota or version keys, including Redis
WRONGTYPE, and generation mismatches fall back to MySQL without repairing the cache. Same-generation Redis balances may still briefly lag asynchronous settlement. Connection, permission, and timeout failures still return HTTP 503. Non-retryable quota publisher enqueue errors increment the server'senqueue_failuresanddroppedcounters once each and return an error without fallback; database errors and timeouts do not incrementdropped. The server-generated HTTP request ID follows the outbox into consume/refund audit records; historical payloads without it remain supported. Execution audit records are retained while their outbox row exists so retries cannot charge twice.
License
MIT
