anigram-mcp 0.0.0-stage → 0.1.1

package/README.md

@@ -1,3 +1,86 @@
-# Temporary Holding Version
+<!-- SPDX-License-Identifier: MIT -->
+<!-- SPDX-FileCopyrightText: 2026 Vaibhav Patel -->
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+# anigram-mcp
+
+The [Anigram](https://github.com/light-vp/Anigram) MCP server. It lets
+a coding assistant (Claude Code, Claude Desktop, Cursor, anything that speaks
+MCP) write living engineering diagrams, run them through a simulated day, and
+draw them.
+
+## Tools
+
+| Tool             | What it does                                                                                         |
+| ---------------- | ---------------------------------------------------------------------------------------------------- |
+| `anigram_guide`  | The scene format, every part that has a drawing, the signal functions. Read first.                   |
+| `list_scenes`    | The built-in sheets.                                                                                 |
+| `get_scene`      | A built-in sheet as JSON — the best example to copy.                                                 |
+| `validate_scene` | Errors (won't load) and warnings (will run, probably not what you meant).                            |
+| `write_scene`    | Validate and save a `.json` scene file.                                                              |
+| `edit_scene`     | Add, move, update or remove parts and links in place.                                                |
+| `check_scene`    | Is it done? Validate, run the day, and check every line of the scene's `expect` list.                |
+| `simulate_scene` | Run a day headless: an hour-by-hour table, every alert, unmet demand. Knobs and switches can be set. |
+| `render_scene`   | The sheet at any hour, every flow labelled: a PNG the assistant can look at (default) or an SVG.     |
+| `share_link`     | A URL that opens the scene live in the browser. The scene travels in the link; nothing is uploaded.  |
+
+Every tool except `anigram_guide` declares an output schema and returns its
+result as structured content too, so a client can read fields instead of
+parsing text.
+
+## Install
+
+Once it is on npm, `npx -y anigram-mcp` is all a client needs (see
+[RELEASING.md](../RELEASING.md)). Until then, from a checkout:
+
+```sh
+git clone https://github.com/light-vp/Anigram anigram
+cd anigram && npm ci && npm run build:mcp
+```
+
+**Claude Code**
+
+```sh
+claude mcp add anigram -- node /path/to/anigram/mcp/dist/anigram-mcp.mjs
+```
+
+**Claude Desktop, Cursor and others** (`mcpServers` in the client's config):
+
+```json
+{
+  "mcpServers": {
+    "anigram": {
+      "command": "node",
+      "args": ["/path/to/anigram/mcp/dist/anigram-mcp.mjs"]
+    }
+  }
+}
+```
+
+The built file is self-contained: React, the solver and the MCP SDK are
+bundled in, so it runs anywhere Node 20+ does. Beside it sit the PNG
+renderer ([resvg](https://github.com/linebender/resvg) as wasm, no browser or
+native build) and the Inter font it draws text with.
+
+## Try
+
+> Draw a narrowboat with solar panels on the roof, a leisure battery and the
+> engine's alternator as backup. Check the battery runs flat overnight and the
+> engine takes over, then give me a link.
+
+The assistant reads the guide, writes the file, simulates a day, adjusts the
+numbers until the story holds, and hands back a link.
+[`examples/narrowboat.json`](../examples/narrowboat.json) is that scene.
+
+## Settings
+
+- Paths are relative to the directory the client starts the server in, and
+  must stay inside it: `../` and absolute paths elsewhere, and symlinks out of
+  it, are refused. It only reads `.json` files, and writes `.json`, `.svg`
+  and `.png`.
+- `ANIGRAM_ALLOW_PATHS` lets it use more folders, separated like `PATH`
+  (`:` on macOS and Linux, `;` on Windows).
+- `ANIGRAM_APP_URL` points `share_link` at another copy of the app
+  (default `https://anigram.vaibhav.co.uk/`), e.g. `http://localhost:5173/`
+  while you run `npm run dev`.
+
+MIT licensed.

package/dist/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Vaibhav Patel
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/OFL.txt

@@ -0,0 +1,92 @@
+Copyright (c) 2016 The Inter Project Authors (https://github.com/rsms/inter)
+
+This Font Software is licensed under the SIL Open Font License, Version 1.1.
+This license is copied below, and is also available with a FAQ at:
+http://scripts.sil.org/OFL
+
+-----------------------------------------------------------
+SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007
+-----------------------------------------------------------
+
+PREAMBLE
+The goals of the Open Font License (OFL) are to stimulate worldwide
+development of collaborative font projects, to support the font creation
+efforts of academic and linguistic communities, and to provide a free and
+open framework in which fonts may be shared and improved in partnership
+with others.
+
+The OFL allows the licensed fonts to be used, studied, modified and
+redistributed freely as long as they are not sold by themselves. The
+fonts, including any derivative works, can be bundled, embedded,
+redistributed and/or sold with any software provided that any reserved
+names are not used by derivative works. The fonts and derivatives,
+however, cannot be released under any other type of license. The
+requirement for fonts to remain under this license does not apply
+to any document created using the fonts or their derivatives.
+
+DEFINITIONS
+"Font Software" refers to the set of files released by the Copyright
+Holder(s) under this license and clearly marked as such. This may
+include source files, build scripts and documentation.
+
+"Reserved Font Name" refers to any names specified as such after the
+copyright statement(s).
+
+"Original Version" refers to the collection of Font Software components as
+distributed by the Copyright Holder(s).
+
+"Modified Version" refers to any derivative made by adding to, deleting,
+or substituting -- in part or in whole -- any of the components of the
+Original Version, by changing formats or by porting the Font Software to a
+new environment.
+
+"Author" refers to any designer, engineer, programmer, technical
+writer or other person who contributed to the Font Software.
+
+PERMISSION AND CONDITIONS
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of the Font Software, to use, study, copy, merge, embed, modify,
+redistribute, and sell modified and unmodified copies of the Font
+Software, subject to the following conditions:
+
+1) Neither the Font Software nor any of its individual components,
+in Original or Modified Versions, may be sold by itself.
+
+2) Original or Modified Versions of the Font Software may be bundled,
+redistributed and/or sold with any software, provided that each copy
+contains the above copyright notice and this license. These can be
+included either as stand-alone text files, human-readable headers or
+in the appropriate machine-readable metadata fields within text or
+binary files as long as those fields can be easily viewed by the user.
+
+3) No Modified Version of the Font Software may use the Reserved Font
+Name(s) unless explicit written permission is granted by the corresponding
+Copyright Holder. This restriction only applies to the primary font name as
+presented to the users.
+
+4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font
+Software shall not be used to promote, endorse or advertise any
+Modified Version, except to acknowledge the contribution(s) of the
+Copyright Holder(s) and the Author(s) or with their explicit written
+permission.
+
+5) The Font Software, modified or unmodified, in part or in whole,
+must be distributed entirely under this license, and must not be
+distributed under any other license. The requirement for fonts to
+remain under this license does not apply to any document created
+using the Font Software.
+
+TERMINATION
+This license becomes null and void if any of the above conditions are
+not met.
+
+DISCLAIMER
+THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
+OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE
+COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
+DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM
+OTHER DEALINGS IN THE FONT SOFTWARE.