diff --git a/.release-please-manifest.json b/.release-please-manifest.json index 823f924..24fe6d3 100644 --- a/.release-please-manifest.json +++ b/.release-please-manifest.json @@ -1,3 +1,3 @@ { - ".": "0.1.0-alpha.37" + ".": "0.1.0-alpha.38" } diff --git a/CHANGELOG.md b/CHANGELOG.md index ea52734..26fd7b2 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,13 @@ # Changelog +## 0.1.0-alpha.38 (2026-09-01) + +Full Changelog: [v0.1.0-alpha.37...v0.1.0-alpha.38](https://github.com/Scan-Documents/node-sdk/compare/v0.1.0-alpha.37...v0.1.0-alpha.38) + +### Documentation + +* **mcp:** document code execution modes and the local code runner ([550f28c](https://github.com/Scan-Documents/node-sdk/commit/550f28c6b1690fef2785703ea78ec777f7616599)) + ## 0.1.0-alpha.37 (2026-07-31) Full Changelog: [v0.1.0-alpha.36...v0.1.0-alpha.37](https://github.com/Scan-Documents/node-sdk/compare/v0.1.0-alpha.36...v0.1.0-alpha.37) diff --git a/package.json b/package.json index eb53797..65ec589 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "scan-documents", - "version": "0.1.0-alpha.37", + "version": "0.1.0-alpha.38", "description": "The official TypeScript library for the Scan Documents API", "author": "Scan Documents ", "types": "dist/index.d.ts", diff --git a/packages/mcp-server/README.md b/packages/mcp-server/README.md index 2c09582..8d7691d 100644 --- a/packages/mcp-server/README.md +++ b/packages/mcp-server/README.md @@ -60,20 +60,33 @@ claude mcp add scan_documents_mcp_api --env SCAN_DOCUMENTS_API_KEY="My API Key" ## Code Mode This MCP server is built on the "Code Mode" tool scheme. In this MCP Server, -your agent will write code against the TypeScript SDK, which will then be executed in an -isolated sandbox. To accomplish this, the server will expose two tools to your agent: +your agent will write code against the TypeScript SDK, which will then be executed in a +sandbox. To accomplish this, the server will expose two tools to your agent: - The first tool is a docs search tool, which can be used to generically query for documentation about your API/SDK. - The second tool is a code tool, where the agent can write code against the TypeScript SDK. - The code will be executed in a sandbox environment without web or filesystem access. Then, - anything the code returns or prints will be returned to the agent as the result of the - tool call. + The code is executed in a sandbox whose filesystem and network access are restricted to + what the SDK needs — see "Where code runs" below. Then, anything the code returns or + prints will be returned to the agent as the result of the tool call. Using this scheme, agents are capable of performing very complex tasks deterministically and repeatably. +### Where code runs + +The `--code-execution-mode` flag controls where the code tool runs your agent's code: + +- `--code-execution-mode=local` runs each code tool call in a Deno subprocess on the same + machine as the MCP server, restricted to reading the server's own files and to making network + requests to your API host. Nothing is sent to Stainless. Deno must be installed for this mode + to work: install it from https://deno.land, or add it to the MCP server's dependencies with + `npm install deno`. + +- `--code-execution-mode=stainless-sandbox` sends the code to a Stainless-hosted sandbox to be + executed there. This mode is deprecated and is being turned off, so use `local` instead. + ## Running remotely Launching the client with `--transport=http` launches the server as a remote server using Streamable HTTP transport. The `--port` setting can choose the port it will run on, and the `--socket` setting allows it to run on a Unix socket. diff --git a/packages/mcp-server/manifest.json b/packages/mcp-server/manifest.json index 9d2a682..4f7b2d2 100644 --- a/packages/mcp-server/manifest.json +++ b/packages/mcp-server/manifest.json @@ -1,7 +1,7 @@ { "dxt_version": "0.2", "name": "scan-documents-mcp", - "version": "0.1.0-alpha.37", + "version": "0.1.0-alpha.38", "description": "The official MCP Server for the Scan Documents API", "author": { "name": "Scan Documents", diff --git a/packages/mcp-server/package.json b/packages/mcp-server/package.json index 5fd33c0..2bbb6b7 100644 --- a/packages/mcp-server/package.json +++ b/packages/mcp-server/package.json @@ -1,6 +1,6 @@ { "name": "scan-documents-mcp", - "version": "0.1.0-alpha.37", + "version": "0.1.0-alpha.38", "description": "The official MCP Server for the Scan Documents API", "author": "Scan Documents ", "types": "dist/index.d.ts", diff --git a/packages/mcp-server/src/server.ts b/packages/mcp-server/src/server.ts index 131fb0d..5f4d09b 100644 --- a/packages/mcp-server/src/server.ts +++ b/packages/mcp-server/src/server.ts @@ -28,7 +28,7 @@ export const newMcpServer = async ({ new McpServer( { name: 'scan_documents_api', - version: '0.1.0-alpha.37', + version: '0.1.0-alpha.38', }, { instructions: await getInstructions({ stainlessApiKey, customInstructionsPath }), diff --git a/src/version.ts b/src/version.ts index 1d95c35..8750540 100644 --- a/src/version.ts +++ b/src/version.ts @@ -1 +1 @@ -export const VERSION = '0.1.0-alpha.37'; // x-release-please-version +export const VERSION = '0.1.0-alpha.38'; // x-release-please-version