proompteng/bilig

CI npm: @bilig/workpaper npm: @bilig/xlsx-formula-recalc npm weekly downloads CodeQL OpenSSF Scorecard License: MIT

Formula workbooks for Node services and agent tools.

Use @bilig/workpaper when a calculation is easiest to review as cells and formulas, but it has to run in a Node service, queue worker, serverless route, test, or coding-agent tool. Use @bilig/xlsx-formula-recalc when the immediate problem is "I changed XLSX inputs in Node and need the formula results now," including SheetJS / xlsx pipelines that already produce XLSX bytes. Use @bilig/exceljs-formula-recalc when the workbook is already moving through ExcelJS.

The scoped @bilig/* packages are the canonical install path. Start with @bilig/workpaper for service-owned workbook state or @bilig/xlsx-formula-recalc for stale XLSX formula values. Use the lower-level runtime only when you are building against advanced subpaths.

It gives you a WorkPaper: build sheets, write inputs, recalculate, read the cell value, and save the workbook as JSON. No browser grid is involved. The published package also carries AGENTS.md and SKILL.md so coding agents inspecting node_modules/@bilig/workpaper can find the write/read/persist loop locally. The repo also includes a Claude Code project skill at .claude/skills/bilig-workpaper/SKILL.md and a Claude Code slash command at .claude/commands/bilig-workpaper-proof.md, a Cursor project rule at .cursor/rules/bilig-workpaper.mdc, and a Windsurf/Cascade rule at .windsurf/rules/bilig-workpaper.md, plus Cline and Continue rules at .clinerules/bilig-workpaper.md and .continue/rules/bilig-workpaper.md, so cloned checkouts expose the same workflow without another install step. GitHub Copilot and VS Code agent mode read the same path from .github/copilot-instructions.md, .github/prompts/bilig-workpaper-proof.prompt.md, and .vscode/mcp.json. The public docs expose the same path through AGENTS.md, skill.md, docs/.well-known/agent.json, AI spreadsheet agent tool, and llms-full.txt.

Good fits: pricing rules, budget checks, payout models, import validation, and agent tools that need read-after-write proof. Bad fits: manual spreadsheet editing, Office macros, desktop Excel automation, or one-off arithmetic where a workbook would be ceremony.

Project site: https://proompteng.github.io/bilig/

Start Here

Pick the path that matches the thing in your hands:

You have...	Start with	You should see
An .xlsx file with stale formula results after editing inputs in Node	XLSX recalculation evaluator	A changed input, a recalculated output, recalculationCompleted: true, and demo expectedValueMatched: true.
An .xlsx model with stale external-link cache values	External workbook recalculation proof	Companion workbook hydration diagnostics, fresh formula readback, and verified: true.
Workbook-shaped business logic that should live in a Node service, test, queue, or route	Node service WorkPaper evaluator	A WorkPaper JSON model that writes inputs, recalculates formulas, restores state, and proves readback.
A coding agent, MCP client, or tool host that needs spreadsheet operations	Agent MCP workbook evaluator	An agent contract with read, write, recalc, persist, restore, and a compact proof object.

If you are not sure which one fits, use the file-level XLSX path when a real spreadsheet file is already the source of truth. Use @bilig/workpaper when the calculation model belongs in code and JSON. Use the agent path when another assistant needs a tool it can verify instead of a browser session it has to trust.

Each evaluator is deliberately small: one command, expected proof, what it proves, what it does not prove, and where to star, watch releases, or report the adoption blocker after the proof runs.

The shortest no-project checks are:

npm exec --package @bilig/xlsx-formula-recalc@latest -- xlsx-recalc --demo --json
npm exec --package @bilig/workpaper@latest -- bilig-agent-challenge --json
npm exec --package @bilig/workpaper@latest -- bilig-mcp-challenge --json

Those commands are intentionally small. If one matches your workflow, continue into the package matrix below; if none match, Bilig is probably not the first tool to evaluate.

If You Only Try One Thing

Most Excel libraries can edit cells and preserve formulas, but they do not refresh the cached formula results that backend jobs actually read. Run this without cloning the repo:

npm exec --package @bilig/xlsx-formula-recalc@latest -- xlsx-recalc --demo --json

Expected shape:

{
  "commandSucceeded": true,
  "recalculationCompleted": true,
  "expectedReadback": {
    "Summary!B2": 72000
  },
  "expectedValueMatched": true,
  "excelParity": "not_proven"
}

The JSON is deliberately clean for CI and agents: no star, release-watch, or discussion links are mixed into the machine-readable proof. Use the links in the surrounding docs after the recalculated value and warnings match your workflow.

For linked workbooks, use the external workbook recalculation proof. For a narrower CLI evaluator, use Evaluate XLSX formula recalculation.

If you already have the real workbook but do not know which formulas to read yet, inspect it first without writing an output file:

npm exec --package @bilig/xlsx-formula-recalc@latest -- xlsx-recalc pricing.xlsx --inspect --json

That returns formula cells, stale cached values, and suggested --read targets so the next command can prove the cells your service actually depends on.

If your pipeline is specifically SheetJS / xlsx, run the sibling proof with the same shape:

npm exec --package @bilig/sheetjs-formula-recalc@latest -- sheetjs-recalc --demo --json

If the workbook is already in ExcelJS, keep that boundary and add @bilig/exceljs-formula-recalc:

npm install exceljs @bilig/exceljs-formula-recalc
npm exec --package @bilig/exceljs-formula-recalc@latest -- exceljs-recalc --demo --json

For one checkout proof across SheetJS/xlsx, xlsx-populate, and ExcelJS:

npm --prefix examples/recalc-bridge-workflows install
npm --prefix examples/recalc-bridge-workflows run smoke

That bridge proof is the fastest way to check whether Bilig solves the stale formula-value problem without asking you to adopt WorkPaper state first.

Which Package Should I Install?

Problem you have right now	Install	First proof
Formula workbook state inside a Node service or agent tool	npm install @bilig/workpaper	90-second Node quickstart
AI agent needs to edit workbook inputs and verify formula readback	npm create @bilig/workpaper@latest pricing-agent -- --agent	AI spreadsheet agent tool
Agent framework or product runtime needs workbook plan/check/proof data	npm install @bilig/workbook	Workbook agent intent API
SheetJS / xlsx pipeline returns stale formula values after input edits	npm install @bilig/sheetjs-formula-recalc	SheetJS formula result not updating
Generic XLSX bytes changed in Node; formula outputs must refresh before returning	npm install @bilig/xlsx-formula-recalc	XLSX formula recalculation in Node.js
XLSX formulas depend on another workbook with stale link caches	npm install @bilig/xlsx-formula-recalc	External workbook recalculation proof
Existing ExcelJS workflow needs recalculated values, not stale cached results	npm install exceljs @bilig/exceljs-formula-recalc	ExcelJS formula recalculation in Node.js
Advanced runtime subpaths, provenance docs, and package-boundary audits	npm install @bilig/headless	npm provenance and package trust

Agent And WorkPaper Proof

For agent adoption, use the Agent Adoption Kit: install the skill, run the no-key MCP proof, paste one workbook task into the agent, and require verified: true before trusting the result.

npx --yes skills@latest add https://bilig.proompteng.ai --list
npx --yes skills@latest add proompteng/bilig --skill bilig-workpaper --list
npm exec --package @bilig/workpaper@latest -- bilig-mcp-challenge --json

Integration Recipes After The Proof

Run one core proof above before wiring a platform-specific integration. These recipes are for teams that already know where the workbook tool needs to live.

Host or workflow runner	Use Bilig when...	Guide
Open WebUI	A local or hosted tool server should expose workbook reads, writes, and formula readback.	Open WebUI WorkPaper tool setup
LobeHub	A LobeHub agent needs a Custom MCP server for workbook tools.	LobeHub WorkPaper MCP setup
AnythingLLM	Agent Skills should call hosted MCP or a private file-backed stdio server.	AnythingLLM WorkPaper MCP setup
Sim	An Agent block or MCP Tool block should read, write, recalculate, and export proof.	Sim WorkPaper MCP setup
FastMCP Python	A Python client should smoke-test hosted MCP before private agent wiring.	FastMCP WorkPaper client
Hugging Face smolagents	A Tool should return structured formula readback proof to a CodeAgent.	smolagents WorkPaper tool
n8n, Dify, Flowise, Pipedream	Workflow builders need formula readback without spreadsheet UI automation; use @bilig/n8n-nodes-workpaper, the upstream merged Dify plugin, or the reviewed Pipedream action.	n8n, Dify, Flowise, Pipedream
Vercel AI SDK	generateText() or streamText() tools need before/after/restore proof.	Vercel AI SDK WorkPaper tools
LangGraph.js / LangChain MCP	ToolNode state should carry WorkPaper proof, or MCP adapters should discover workbook tools.	LangGraph, LangChain MCP example
Windmill, Trigger.dev Durable Formula Tasks, Inngest	Durable workflow code should calculate fields from reviewable formulas.	Windmill, Trigger.dev, Inngest
Airbyte, Meltano	Post-sync or post-ELT validation should return formula-backed record/state proof.	Airbyte, Meltano
Temporal, Airflow, Dagster Formula Assets, Kestra, Prefect	Orchestrators should own retries/history while a Node step owns workbook proof.	Temporal, Airflow, Dagster, Kestra, Prefect
Directus Persisted Calculated Fields	A custom operation should persist calculated fields with formula proof.	Directus WorkPaper Flow operation

Choose An Evaluation Path

If you are evaluating...	Start here	What should be true before you adopt
Existing XLSX files	XLSX recalculation evaluator	A command edits inputs, reads recalculated values, writes XLSX, and returns recalculationCompleted: true.
Node service formulas	Node service WorkPaper evaluator	A starter writes one input, recalculates, persists JSON, restores, and prints verified: true.
Agent MCP contract	Agent MCP workbook evaluator	MCP tool discovery, input edit, formula readback, persistence, and restart proof all pass.
Agent intent/runtime adapters	Workbook agent intent API and workbook-agent-model example	A model prepares transport-neutral plan data, strict runtime proof, command receipts, and check evidence.
Basic fit	Why use Bilig?	The problem is workbook-shaped business logic that needs API readback and persistence.
Published npm package	90-second Node quickstart	@bilig/workpaper edits one input, recalculates, persists JSON, restores, and prints verified: true.
XLSX or ExcelJS recalculation	XLSX formula recalculation and ExcelJS formula recalculation	The package updates inputs, reads recalculated values, and exports or mutates the workbook boundary.
Backend service shape	Quote approval WorkPaper API	A realistic route-style workflow returns formula readback and restoredMatchesAfter: true.
Agent or MCP tools	Headless WorkPaper agent handbook, MCP spreadsheet tool server, Gemini CLI extension, and Claude Desktop MCPB bundle	The agent installs a tool path, gets a copy-paste handoff prompt, then proves write/readback/persist.
Agent-owned XLSX files	Agent XLSX recalculation without LibreOffice	A tool can edit XLSX inputs, recalculate, export, reimport, and return verified: true.
Public technical review	Show HN maintainer note	One shareable page has the npm check, benchmark caveat, known limits, and feedback ask.
Trust and performance	npm provenance and benchmark evidence	npm shows SLSA provenance, and benchmark claims match the checked artifact.
Almost a fit	adoption blocker form	Name the formula, import/export, persistence, framework, MCP, package, or benchmark gap.
Formula or XLSX bug	formula bug clinic	Share a reduced public case that can become a test, example, corpus fixture, or docs proof.
Real workbook blocked	submit a workbook fixture	Use the structured form when a reduced workbook is ready.

Reduced workbook already in hand? Generate the paste-ready fixture report in one command:

npm exec --package @bilig/workpaper -- bilig-formula-clinic ./reduced.xlsx --cells "Summary!B7,Inputs!B2"

Handing a spreadsheet task to another coding agent? Start with the agent handoff prompt before opening Excel, LibreOffice, Google Sheets, or a screenshot UI. To prove the package-owned agent loop without cloning the repo or downloading a TypeScript file:

npm exec --package @bilig/workpaper@latest -- bilig-agent-challenge --json
npm exec --package @bilig/workpaper@latest -- bilig-mcp-challenge --json

Agent tools that support skill manifests can start from skill.md or the well-known index at docs/.well-known/agent-skills/index.json. Claude Code reads the project skill from .claude/skills/bilig-workpaper/SKILL.md when the repo is cloned locally, and can invoke the explicit proof prompt from .claude/commands/bilig-workpaper-proof.md. Cursor and Windsurf/Cascade read the same proof loop from .cursor/rules/bilig-workpaper.mdc and .windsurf/rules/bilig-workpaper.md. Cline and Continue read the workspace rules from .clinerules/bilig-workpaper.md and .continue/rules/bilig-workpaper.md. GitHub Copilot and VS Code agent mode read the repository instructions, prompt, and MCP servers from .github/copilot-instructions.md, .github/prompts/bilig-workpaper-proof.prompt.md, and .vscode/mcp.json. Gemini CLI users can install Bilig as an extension:

gemini extensions install https://github.com/proompteng/bilig --ref main

Claude Desktop users can also install the released MCPB bundle directly: https://github.com/proompteng/bilig/releases/latest/download/bilig-workpaper.mcpb. If you need a copy-paste eval for another tool host, use the agent workbook challenge: one input edit, one dependent formula readback, one serialized restore, and a verified: true proof object.

Try It In 90 Seconds

This uses the published npm package. It builds a workbook, changes one input, reads the calculated value, saves JSON, restores the workbook, and prints the same value again.

npm create @bilig/workpaper@latest pricing-workpaper
cd pricing-workpaper
npm install
npm run smoke

Expected output includes this proof shape:

{
  "before": {
    "summary": {
      "decision": "review"
    },
    "inputCells": {
      "units": "Inputs!B2",
      "listPrice": "Inputs!B3"
    }
  },
  "edit": {
    "before": {
      "decision": "review"
    },
    "after": {
      "decision": "approved"
    },
    "restored": {
      "decision": "approved"
    },
    "checks": {
      "decisionChanged": true,
      "formulasPersisted": true,
      "restoredMatchesAfter": true,
      "serializedBytes": 1242
    }
  },
  "verified": true,
  "star": "https://github.com/proompteng/bilig/stargazers",
  "watchReleases": "https://github.com/proompteng/bilig/subscription",
  "adoptionBlocker": "https://github.com/proompteng/bilig/discussions/new?category=general",
  "nextStep": {
    "ifUseful": "If this proof matched your workflow, star or bookmark Bilig so you can find it again.",
    "star": "https://github.com/proompteng/bilig/stargazers",
    "watchReleases": "https://github.com/proompteng/bilig/subscription",
    "ifBlocked": "If it almost worked, open the concrete workbook or agent blocker.",
    "adoptionBlocker": "https://github.com/proompteng/bilig/discussions/new?category=general"
  }
}

The generated starter uses the same maintained WorkPaper proof shape as the public mirror at https://proompteng.github.io/bilig/npm-eval.ts and examples/headless-workpaper/npm-eval.ts. The exact byte count can change between package versions; verified: true, decisionChanged, formulasPersisted, and restoredMatchesAfter are the checks.

For a route-shaped quote approval API today, run the maintained example:

git clone --depth 1 https://github.com/proompteng/bilig.git
cd bilig
pnpm --dir examples/serverless-workpaper-api install --ignore-workspace
pnpm --dir examples/serverless-workpaper-api run smoke

For a generated project from a blank directory, run npm create @bilig/workpaper@latest pricing-workpaper through the @bilig/create-workpaper package. The package source lives in packages/create-workpaper, and the publish gate is documented in create a Bilig WorkPaper starter. For an agent-ready project with AGENTS.md, CLAUDE.md, GEMINI.md, Copilot / Cursor / Cline / Continue / Windsurf rules, MCP client configs, and an agent:verify script, run npm create @bilig/workpaper@latest pricing-agent -- --agent.

If that proof almost matches a service or agent workflow you maintain, the useful next step is concrete feedback: open or answer one adoption blocker in Discussions: formula coverage, stale XLSX cached values, persistence shape, MCP/agent writeback, or benchmark coverage.

TypeScript API Shape

Most integrations are just this: build a workbook, write an input, read the calculated value, and save the workbook state.

import { WorkPaper, exportWorkPaperDocument, serializeWorkPaperDocument } from '@bilig/workpaper'

const workbook = WorkPaper.buildFromSheets({
  Inputs: [
    ['Metric', 'Value'],
    ['Customers', 20],
    ['Average revenue', 1200],
  ],
  Summary: [
    ['Metric', 'Value'],
    ['Revenue', '=Inputs!B2*Inputs!B3'],
  ],
})

const inputs = workbook.getSheetId('Inputs')
const summary = workbook.getSheetId('Summary')
if (inputs === undefined || summary === undefined) {
  throw new Error('Workbook is missing required sheets')
}

workbook.setCellContents({ sheet: inputs, row: 1, col: 1 }, 32)

const revenue = workbook.getCellDisplayValue({ sheet: summary, row: 1, col: 1 })
const saved = serializeWorkPaperDocument(exportWorkPaperDocument(workbook, { includeConfig: true }))

console.log({ revenue, savedBytes: saved.length })

When To Reach For It

Use @bilig/workpaper when:

• a Node service owns a workbook-shaped calculation;
• an agent needs tools such as readRange and setInputCell, with computed before/after values instead of screenshots;
• tests need deterministic spreadsheet state and formula readback;
• a workflow needs to save the edited workbook as JSON and restore it later.

Use something else when you need a visual spreadsheet grid, Office macros, desktop Excel automation, or a one-off arithmetic helper. Do not treat embedded XLSX cached formula values as truth; use the Excel oracle workflow when accuracy matters.

Package Boundary

Current checked npm footprint for @bilig/[email protected]:

• Pack dry run: 821 kB tarball, 5.03 MB unpacked, 798 package entries.
• Boundary: the main import is the WorkPaper formula/JSON runtime; XLSX import/export stays behind the @bilig/headless/xlsx subpath; MCP is the bilig-workpaper-mcp binary wrapper; reduced workbook reports use the bilig-formula-clinic binary.
• Cold-start gate: Node imports the main entrypoint, builds a two-sheet WorkPaper, and reads 24000 under 1000 ms without importing the XLSX subpath.
• Runtime: Node >=22.0.0; Node 22 compatibility is covered by the runtime package workflow.

Published Package Trust

@bilig/headless is published with npm registry signatures and SLSA provenance attestations. Verify the package version you are about to adopt:

npm view @bilig/headless version dist.attestations dist.signatures --json

After installing, npm can verify the current dependency tree:

npm audit signatures

The current package trust path is documented in npm provenance and package trust. Repository security posture is tracked by OpenSSF Scorecard and uploaded to GitHub code scanning on every main update.

Deeper Evaluation Paths

After the first proof in Start Here, use the deeper guide that matches the next job.

1. Run the 90-second npm eval in a blank project.
2. Run the flagship serverless WorkPaper API example: npm run quote-approval-api.
3. If the workflow starts with an XLSX file, run the XLSX formula recalculation in Node: npm start.
4. If an agent needs workbook tools, start with the headless WorkPaper agent handbook, then use the MCP server guide when the caller is an MCP client.
5. If a real workbook almost works, start with the formula bug clinic. Then submit a reduced public fixture so the blocker can become a test, example, or corpus case instead of private feedback. Form: https://github.com/proompteng/bilig/issues/new?template=workbook_fixture.yml. Discussion: https://github.com/proompteng/bilig/discussions/414.

The rest of the docs are an index, not a prerequisite.

For comparison and integration details, use the plain-language fit guide, screenshot automation boundary, Google Sheets API boundary, workbook automation examples, the formula workbooks proof page, the Node spreadsheet formula engine guide, server-side spreadsheet automation, framework adapters, formula bug clinic, workbook fixture submissions, OpenAI Agents SDK tools, AI SDK and LangChain tools, CrewAI adapter, the headless WorkPaper agent handbook, the MCP server guide, spreadsheet MCP server comparison, MCP directory status, MCP client setup, Gemini CLI extension, FastMCP Python client, Claude Desktop MCPB bundle, npm provenance and package trust, JavaScript library comparison, headless spreadsheet engine for Node services and agents, XLSX formula recalculation in Node.js, agent XLSX formula recalculation without LibreOffice, Excel file as a Node calculation engine, stale XLSX formula cache in Node.js, SheetJS formula result not updating in Node.js, Microsoft Graph Excel recalculation in Node.js, xlsx-calc alternative for Node workbook recalculation, ExcelJS formula recalculation in Node.js, ExcelJS shared formulas in Node.js, SheetJS/ExcelJS boundary, and headless engine comparison.

Useful deeper examples: invoice totals, budget variance alerts, fulfillment capacity plan, quote approval threshold, subscription MRR forecast, agent framework adapters, MCP tool server shape, XLSX formula recalculation in Node, and serverless quote approval. Run npm run quote-approval-api, npm run agent:openai-agents-sdk, npm run agent:framework-adapters, npm run agent:mcp-tools, npm run agent:mcp-transcript, npm run agent:mcp-file-transcript, npm run agent:mcp-stdio, or npm exec --package @bilig/workpaper -- bilig-workpaper-mcp when that is the path you are evaluating.

The serverless example also includes npm run next-route-handler, npm run next-server-action, npm run next-server-action-formdata, npm run framework-adapters, and npm run persistence-adapters for framework-specific boundary checks.

The MCP server is also listed in the official registry: https://registry.modelcontextprotocol.io/v0.1/servers?search=io.github.proompteng%2Fbilig-workpaper. Clients that support Streamable HTTP MCP can also smoke-test the stateless hosted endpoint at https://bilig.proompteng.ai/mcp; use the local stdio server when the agent needs to persist a project WorkPaper JSON file.

Examples You Can Run

The runnable examples are TypeScript files. Some source imports end in .js because Node ESM resolves compiled package output that way; the files you edit and run are still .ts.

From a cloned checkout:

pnpm --dir examples/headless-workpaper install --ignore-workspace
pnpm --dir examples/headless-workpaper run start
pnpm --dir examples/headless-workpaper run json-records
pnpm --dir examples/headless-workpaper run csv-shaped
pnpm --dir examples/headless-workpaper run invoice-totals
pnpm --dir examples/headless-workpaper run budget-variance
pnpm --dir examples/headless-workpaper run fulfillment-capacity
pnpm --dir examples/headless-workpaper run quote-approval
pnpm --dir examples/headless-workpaper run subscription-mrr
pnpm --dir examples/headless-workpaper run persistence

The most useful entry points:

• JSON records input
• CSV shaped input
• invoice totals
• budget variance alerts
• fulfillment capacity plan
• quote approval threshold
• subscription MRR forecast
• SheetJS, xlsx-populate, and ExcelJS recalculation bridge

For agent tools:

pnpm --dir examples/headless-workpaper run agent:verify
pnpm --dir examples/headless-workpaper run agent:tool-call
pnpm --dir examples/headless-workpaper run agent:openai-agents-sdk
pnpm --dir examples/headless-workpaper run agent:openai-agents-sdk-mcp
pnpm --dir examples/headless-workpaper run agent:openai-responses
pnpm --dir examples/headless-workpaper run agent:ai-sdk-generate-text
pnpm --dir examples/headless-workpaper run agent:ai-sdk-stream-text
pnpm --dir examples/headless-workpaper run agent:framework-adapters
pnpm --dir examples/langgraph-workpaper-tool-state run smoke
pnpm --dir examples/langchain-mcp-workpaper-toolnode run smoke
pnpm --dir examples/headless-workpaper run agent:mcp-tools
pnpm --dir examples/headless-workpaper run agent:mcp-file-transcript
pnpm --dir examples/headless-workpaper run agent:mcp-stdio

The AI SDK example uses ai-sdk-generate-text-tool-smoke.ts. The OpenAI Agents SDK guide is docs/openai-agents-sdk-workpaper-tool.md. It includes both direct tool() wrapping and MCPServerStdio discovery through the same WorkPaper MCP tool loop. The OpenAI Responses guide is docs/openai-responses-workpaper-tool-call.md. The agent framework guide is docs/vercel-ai-sdk-langchain-spreadsheet-tool.md. The LangGraph.js ToolNode proof is docs/langgraph-workpaper-toolnode-spreadsheet.md. It includes a no-key @langchain/mcp-adapters smoke that discovers the published WorkPaper MCP stdio tools and executes them through ToolNode.

The package also ships the MCP stdio binary:

npm exec --package @bilig/workpaper@latest -- bilig-agent-challenge --json
npm exec --package @bilig/workpaper@latest -- bilig-formula-clinic ./reduced.xlsx --cells "Summary!B7,Inputs!B2"
npm exec --package @bilig/workpaper@latest -- bilig-mcp-challenge --json
npm exec --package @bilig/workpaper@latest -- bilig-workpaper-mcp
npm exec --package @bilig/workpaper@latest -- bilig-workpaper-mcp --workpaper ./pricing.workpaper.json --init-demo-workpaper --writable
npm exec --package @bilig/headless@latest -- bilig-workpaper-mcp
docker build --target bilig-workpaper-mcp -t bilig-workpaper-mcp:local .

bilig-agent-challenge prints the same edit, formula readback, WorkPaper JSON export, restore, and verified: true proof object used by the agent workbook challenge page.

bilig-mcp-challenge proves the file-backed MCP path end to end: initialize JSON-RPC, list tools/resources/prompts, edit Inputs!B3, read recalculated Summary!B3, export the WorkPaper JSON, restart from disk, and return verified: true.

bilig-formula-clinic imports a reduced XLSX locally, samples formulas, reads requested cells through WorkPaper, and prints a Markdown issue body. It does not upload workbook contents.

Without --workpaper, the binary starts the built-in demo workbook. With --workpaper, it loads your persisted WorkPaper JSON and exposes list_sheets, read_range, read_cell, set_cell_contents, set_cell_contents_and_readback, get_cell_display_value, export_workpaper_document, and validate_formula; --writable persists set_cell_contents or set_cell_contents_and_readback edits back to the same file. It also exposes MCP resources and prompts for bilig://workpaper/agent-handoff, bilig://workpaper/current-document, edit_and_verify_workpaper, and debug_workpaper_formula, so capable clients can discover the workflow before calling tools. The Docker target is for MCP directory scanners: it seeds a demo WorkPaper JSON inside the image and starts the file-backed --writable tool surface so tools/list, resources/list, and prompts/list return the general WorkPaper agent surface without cloning this monorepo. For remote MCP clients, the app runtime exposes https://bilig.proompteng.ai/mcp as a stateless JSON-only Streamable HTTP endpoint for tool discovery and write/readback smoke tests.

It is published in the official MCP Registry as io.github.proompteng/bilig-workpaper: https://registry.modelcontextprotocol.io/v0.1/servers?search=io.github.proompteng%2Fbilig-workpaper. It is also live on Glama with Try in Browser, A-grade tool pages, and the file-backed WorkPaper tools: https://glama.ai/mcp/servers/proompteng/bilig.

Proof You Can Reproduce

• The 90-second TypeScript check above edits one input, restores the saved JSON document, and verifies the dependent formula result.
• For a production-shaped evaluator path, run the quote approval WorkPaper API proof. It starts from an empty Node directory, downloads one maintained TypeScript route smoke, writes quote inputs, recalculates an approval decision, persists JSON, and verifies restored readback.
• For an XLSX formula recalculation example, run examples/xlsx-recalculation-node. It imports a generated XLSX pricing workbook, edits input cells, reads the recalculated approval decision, exports XLSX, reimports it, and verifies the formulas survived the round trip. The public decision page is XLSX formula recalculation in Node.js.
• For a shorter public decision page, read formula workbooks for Node services and agent tools. It compresses the WorkPaper boundary, MCP file-backed mode, benchmark caveat, and alternative-tool guidance into one shareable evaluator path.
• For HN, Lobsters, Reddit, or newsletter review, use the Show HN maintainer note. It keeps the empty npm-project command, verified: true output, benchmark caveat, known limits, and feedback ask together.
• Run pnpm workpaper:bench:competitive:check. The checked-in artifact shows 100/100 comparable WorkPaper mean wins and 100/100 mean+p95 wins; the current worst p95 row is sheet-rename-dependencies at 0.792x.
• The benchmark card is generated from that artifact: docs/assets/workpaper-benchmark-card.png.
• Read the compatibility limits before importing real Excel workbooks.
• Use the production adoption checklist before promoting a WorkPaper-backed workflow beyond evaluation.
• For XLSX accuracy audits, use the Excel oracle harness. It separates import success, timeouts, stale cached formula values, and fresh Microsoft Excel recalculation results.
• The WorkPaper MCP server is listed in the official MCP Registry and on Glama. The directory status page keeps the npm command, remote endpoint, static MCP server card, and directory evidence in one place.
• Public feedback threads: workflow questions, service examples, persistence adapters, JavaScript spreadsheet library guide, OpenAI Responses tool calls, and benchmark critique.

If you are evaluating Bilig runtime packages for production and want release notifications, watch releases: https://github.com/proompteng/bilig/subscription.

XLSX Accuracy Policy

Cached formula values embedded in .xlsx files are cache diagnostics, not an accuracy verdict. A Bilig correctness bug should only be claimed when the expected value came from a fresh Excel recalculation oracle.

OUT=.cache/excel-oracle-evaluation
pnpm workpaper:xlsx-oracle -- prepare-oracle /path/to/xlsx-corpus "$OUT"
pnpm workpaper:xlsx-oracle -- evaluate-cache /path/to/xlsx-corpus "$OUT"
pnpm workpaper:xlsx-oracle -- evaluate-oracle /path/to/xlsx-corpus "$OUT/recalculated" "$OUT"
pnpm workpaper:xlsx-oracle -- summarize "$OUT"

evaluate-cache writes cache-diagnostic.json and stays non-authoritative. evaluate-oracle writes excel-oracle-report.json, and summarize writes summary.md. If Excel automation is unavailable, cells are classified as missing_excel_oracle instead of being promoted to bugs.

What Is In This Repo

• packages/headless: WorkPaper runtime and npm package.
• packages/excel-import: XLSX import/export boundary. Install both packages with pnpm add @bilig/headless @bilig/excel-import when you need file import and export.
• packages/formula: formula parser, binder, compiler, and evaluator.
• packages/core: workbook engine, snapshots, mutation flow, and scheduler.
• packages/grid and apps/web: browser spreadsheet shell.
• apps/bilig: fullstack monolith runtime, API surface, and static asset server.
• packages/renderer: React workbook renderer.
• packages/protocol, packages/binary-protocol, packages/agent-api, and packages/worker-transport: protocol and integration boundaries.
• packages/wasm-kernel: AssemblyScript/WASM numeric fast path.
• packages/benchmarks: benchmark harness and performance contracts.

For XLSX import/export from TypeScript:

import { WorkPaper } from '@bilig/headless'
import { exportXlsx, importXlsx } from '@bilig/excel-import'

Use WorkPaper.buildFromSnapshot(imported.snapshot) after import and workbook.exportSnapshot() before exportXlsx().

Local Development

Use Node 24+, Bun, and [email protected].

pnpm install
pnpm dev:web
pnpm dev:web-local
pnpm dev:sync

For a full local preflight:

pnpm lint
pnpm typecheck
pnpm test
pnpm test:browser
pnpm run ci

Generated sources and public evidence are checked:

pnpm protocol:check
pnpm formula-inventory:check
pnpm workspace-resolution:check
pnpm workpaper:bench:competitive:check
pnpm docs:discovery:check

For Coding Agents

Start with the public package boundary unless the task is explicitly engine work.

1. Read packages/workpaper/README.md before touching public WorkPaper behavior.
2. Read docs/AGENTS.md, docs/skill.md, or docs/llms-full.txt when building an agent-facing integration from outside the repo.
3. Use public exports from @bilig/workpaper; do not reach into src/ or dist/ when writing consumer examples.
4. Keep examples TypeScript-first.
5. Do not call stale XLSX cached formula values an accuracy oracle.
6. Add focused tests before changing formulas, persistence, range bounds, config rebuilds, events, row/column moves, or sheet lifecycle.
7. Run the focused package tests first, then broaden to pnpm run ci.

Contributing

Read CONTRIBUTING.md before opening a PR. If this is your first patch, start with the new contributor guide and then claim a scoped starter issue.

Good first patches usually fit one of these shapes:

• formula fixtures with clear expected behavior;
• small WorkPaper examples that prove a real service or agent workflow;
• focused correctness fixes with regression tests;
• grid accessibility and keyboard-behavior improvements;
• docs that turn an existing architecture note into a runnable command.

The shortest public on-ramp is the starter issues queue. It keeps code/test picks, example tasks, adapters, and focused docs work in one current list, with small acceptance commands for first patches.

If this is your first contribution to bilig, use the first-timers-only filter.

Security And Support

Read SECURITY.md before sharing vulnerability details, private workbook data, tokens, credentials, or exploit reproductions. Security reports should use GitHub private vulnerability reporting when available, or [email protected] when the private flow is not visible.

Use SUPPORT.md for the fastest public support path. Good reports include the package version, Node version, OS, exact formula or workbook input, expected value, actual value, and the smallest command or script that reproduces the issue.

CI

Forgejo Actions is the primary CI surface via .forgejo/workflows/forgejo-ci.yml. GitHub Actions mirrors the verification contract in .github/workflows/ci.yml.

The strict gate includes frozen lockfile install, full pnpm run ci, artifact budget checks, browser smoke, and tracked-file cleanliness checks.

License

MIT.