@vumasign/mcp 0.3.2 → 0.3.4

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Vumasign (Pty) Ltd
+
+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/README.md

@@ -1,5 +1,7 @@
 # @vumasign/mcp
 
+[![npm](https://img.shields.io/npm/v/@vumasign/mcp)](https://www.npmjs.com/package/@vumasign/mcp) [![licence](https://img.shields.io/npm/l/@vumasign/mcp)](./LICENSE) [![node](https://img.shields.io/node/v/@vumasign/mcp)](https://www.npmjs.com/package/@vumasign/mcp)
+
 An MCP server for a Vumasign account. An agent can read your templates, their pages and the core
 vocabulary with your organisation’s own keys,
 check the values it means to fill in, and create **draft** envelopes. A person reviews each draft in
@@ -8,9 +10,39 @@ Vumasign and sends it.
 It never sends an envelope, never mints a signing URL, never names a field freely, never creates a
 template and never touches a webhook. There is no tool for any of them.
 
-Three tools change a template, and exist only when `VUMASIGN_MCP_ALLOW_TEMPLATE_WRITES=1` is set:
-`request_naming`, `accept_naming` and `accept_person`. They accept Vumasign’s own naming of a
-template and nothing of the agent’s, and need a live key that also names `templates:name`.
+The tools that change a template exist only when `VUMASIGN_MCP_ALLOW_TEMPLATE_WRITES=1` is set. They
+accept Vumasign’s own naming of a template and nothing of the agent’s.
+
+## Tools
+
+<!-- tools:start (generated by scripts/readme-tools.ts, do not edit) -->
+
+| Tool | What it does |
+| --- | --- |
+| `list_templates` | List templates |
+| `get_template` | Get a template |
+| `get_vocabulary` | Get the vocabulary |
+| `get_template_page` | Get one page of a template document |
+| `get_template_document` | Get a whole template document |
+| `get_template_field_map` | Get a template document with its fields numbered on it |
+| `validate_values` | Check values against a template |
+| `get_envelope` | Get an envelope |
+| `create_envelope_draft` | Create a draft envelope |
+| `get_naming_run` | Read a naming run |
+| `get_template_people` | Get the people on a template |
+
+Only with `VUMASIGN_MCP_ALLOW_TEMPLATE_WRITES=1`, and a live key that also names `templates:name`:
+
+| Tool | What it does |
+| --- | --- |
+| `request_naming` | Ask Vumasign to name a template |
+| `accept_naming` | Accept a naming run |
+| `accept_person` | Accept Vumasign’s proposal for one person |
+
+<!-- tools:end -->
+
+Parameters, examples and setup for each client are in the
+[guide](https://docs.vumasign.com/guides/agents-and-mcp).
 
 ## Use
 
@@ -36,6 +68,8 @@ The guide, with setup for Claude Code, Claude Desktop and Cursor and the full li
 
 ## Develop
 
+The source is maintained in Vumasign’s private repository, so the Repository link on npm is not public. Questions and issues go through [docs.vumasign.com](https://docs.vumasign.com).
+
 The source is in `src/` and the tests in `test/`. Inside the Vumasign repository the package resolves
 its dependencies from the repository root, and the root `npm test` runs `test/` too.
 
@@ -46,3 +80,7 @@ npm run build      # writes dist/
 ```
 
 Releasing is described in `docs/deployment/mcp-package.md` in the repository.
+
+## Licence
+
+MIT. See [LICENSE](./LICENSE).

package/dist/meta.js

@@ -1,6 +1,6 @@
 /** The package's name and version, which `test/package.test.ts` holds equal to `package.json`. */
 export const PACKAGE_NAME = '@vumasign/mcp';
-export const VERSION = '0.3.2';
+export const VERSION = '0.3.4';
 /** The command `npx` runs, from `bin` in `package.json`. */
 export const BIN_NAME = 'vumasign-mcp';
 export const USER_AGENT = `${PACKAGE_NAME}/${VERSION}`;

package/dist/tools.js

@@ -294,7 +294,8 @@ export const TOOLS = [
     {
         name: 'get_template',
         title: 'Get a template',
-        description: 'Reads one template: its documents, page sizes, roles, subjects, questions, and every field with ' +
+        description: 'Reads one template: its documents, page sizes, roles (each with its `kind`, a party or a witness, and ' +
+            'its `step`, when it is asked), subjects, questions, and every field with ' +
             'its data key, `rect` and `context` (the words printed around the box), plus `coverage`, ' +
             '`warnings` and the template’s `etag`. Use the fields’ data keys as the `key` of each value. A ' +
             'question has its own `data_key` and `options`, and each of its boxes an `option_value`: send the ' +
@@ -457,7 +458,8 @@ export const TOOLS = [
     {
         name: 'get_envelope',
         title: 'Get an envelope',
-        description: 'Reads one envelope by id: its status, recipients and documents. Use it to confirm what ' +
+        description: 'Reads one envelope by id: its status, recipients, documents and `subjects` (each with whether it is ' +
+            '`present` on this envelope). Use it to confirm what ' +
             '`create_envelope_draft` made.',
         inputSchema: {
             type: 'object',
@@ -495,7 +497,10 @@ export const TOOLS = [
                 recipients: {
                     type: 'array',
                     description: 'Who fills each of the template’s roles, as `POST /api/v1/envelopes` takes them: each with ' +
-                        '`role`, `name` and `email`.',
+                        '`role`, `name` and `email`, and optionally `step`, a whole number, on every recipient or on none. ' +
+                        'Everyone in the lowest unfinished step is asked together. With no `step`, everyone is asked at once ' +
+                        'when the template’s signing roles share one step, and otherwise one at a time in the array’s order. ' +
+                        'Whether a role is a party or a witness is the template’s, from `get_template`.',
                     minItems: 1,
                     maxItems: RECIPIENTS_MAX,
                     items: { type: 'object' },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vumasign/mcp",
-  "version": "0.3.2",
+  "version": "0.3.4",
   "description": "MCP server for a Vumasign account: read templates and their pages, check values, and create draft envelopes that a person sends. It never sends and never mints a signing URL.",
   "keywords": [
     "mcp",
@@ -14,7 +14,7 @@
     "url": "git+https://github.com/HelloCrowd/Vumasign.git",
     "directory": "mcp"
   },
-  "license": "UNLICENSED",
+  "license": "MIT",
   "type": "module",
   "engines": {
     "node": ">=20"