@desktopaccountingapi/quickbooks-desktop-mcp 0.1.1 → 0.2.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  ## 0.1.0
4
4
 
5
- First release of `@desktopaccountingapi/quickbooks-desktop-mcp`, generated from API contract sha256 `1cc3058cecb5` (API version 1.0.0, 275 operations).
5
+ First release of `@desktopaccountingapi/quickbooks-desktop-mcp`, generated from API contract sha256 `b5774d24bc81` (API version 1.0.0, 275 operations).
6
6
 
7
7
  - Local MCP server over stdio: `npx -y @desktopaccountingapi/quickbooks-desktop-mcp`. Node.js 20 or later on Windows, macOS and Linux; no other runtime and no runtime dependencies.
8
8
  - Tools: `list_end_users`, `list_api_endpoints`, `get_api_endpoint_schema`, `invoke_api_endpoint`, `search_docs`; optional one tool per operation with `--resources`.
package/README.md CHANGED
@@ -6,7 +6,7 @@
6
6
  - Writes carry an idempotency key and are never retried blindly. Read-only keys are enforced by the API itself.
7
7
  - Runs over stdio with Node.js 20 or later on Windows, macOS and Linux, with no runtime dependencies.
8
8
 
9
- The current version is **0.1.1**. [MCP guide](https://www.desktopaccountingapi.com/docs/guides/mcp/) · [Documentation](https://www.desktopaccountingapi.com/docs/) · [Changelog](CHANGELOG.md) · [Status](https://status.desktopaccountingapi.com)
9
+ The current version is **0.2.1**. [MCP guide](https://www.desktopaccountingapi.com/docs/guides/mcp/) · [Documentation](https://www.desktopaccountingapi.com/docs/) · [Changelog](CHANGELOG.md) · [Status](https://status.desktopaccountingapi.com)
10
10
 
11
11
  ## Hosted server or local package
12
12
 
@@ -37,14 +37,14 @@ Open **Settings > Developer > Edit Config** (`claude_desktop_config.json`) and a
37
37
  "mcpServers": {
38
38
  "quickbooks-desktop": {
39
39
  "command": "npx",
40
- "args": ["-y", "@desktopaccountingapi/quickbooks-desktop-mcp@0.1.1"],
40
+ "args": ["-y", "@desktopaccountingapi/quickbooks-desktop-mcp@0.2.1"],
41
41
  "env": { "DAAPI_SECRET_KEY": "sk_live_..." }
42
42
  }
43
43
  }
44
44
  }
45
45
  ```
46
46
 
47
- If the file already has an `mcpServers` section, add the `quickbooks-desktop` entry inside it, then restart Claude Desktop. Drop `@0.1.1` from the package name to always run the latest version.
47
+ If the file already has an `mcpServers` section, add the `quickbooks-desktop` entry inside it, then restart Claude Desktop. Drop `@0.2.1` from the package name to always run the latest version.
48
48
 
49
49
  ### Claude Code
50
50
 
@@ -118,6 +118,8 @@ Ask the agent: "List my QuickBooks Desktop end users and show the 5 most recent
118
118
  | `--version` | | Print the version. |
119
119
  | `--help` | | Print the options. |
120
120
 
121
+ We recommend a **read-only** secret key for AI tools. The API rejects every write made with it (`403 API_KEY_READ_ONLY`), whatever the client does, and the server detects such a key and hides write operations without `--read-only`. QuickBooks data in tool results is wrapped in `<untrusted-data>` with a note telling the model not to follow instructions found inside it.
122
+
121
123
  ## Tools
122
124
 
123
125
  | Tool | What it does |
@@ -140,7 +142,7 @@ With `--resources`, each operation of those resources also becomes its own tool,
140
142
 
141
143
  ## Read-only access
142
144
 
143
- Create a **read-only** secret key in the dashboard and use it in the setup above. The API enforces it for every client: a read-only key can call every `GET` operation and passthrough requests that contain only queries, and any other call returns `403 API_KEY_READ_ONLY` before anything reaches QuickBooks. Add `--read-only` (or `DAAPI_MCP_READ_ONLY=true`) to also hide write tools from the agent; the read-only key is what guarantees writes cannot happen.
145
+ Create a **read-only** secret key in the dashboard and use it in the setup above. The API enforces it for every client: a read-only key can call every `GET` operation and passthrough requests that contain only queries, and any other call returns `403 API_KEY_READ_ONLY` before anything reaches QuickBooks. The server recognizes a read-only key and hides write tools from the agent on its own. Add `--read-only` (or `DAAPI_MCP_READ_ONLY=true`) to hide them for a full-access key too; the read-only key is what guarantees writes cannot happen.
144
146
 
145
147
  ## Use as a library
146
148
 
@@ -171,7 +173,7 @@ Clients send their own secret key as `Authorization: Bearer sk_...`; the server
171
173
  ## Versioning and changelog
172
174
 
173
175
  - The package follows [semantic versioning](https://semver.org/) and is released together with the [Node.js](https://github.com/DesktopAccountingAPI/quickbooks-desktop-node), [Python](https://github.com/DesktopAccountingAPI/quickbooks-desktop-python), [.NET](https://github.com/DesktopAccountingAPI/quickbooks-desktop-dotnet) and [Java](https://github.com/DesktopAccountingAPI/quickbooks-desktop-java) SDKs, with the same version number.
174
- - It is generated from the Desktop Accounting API contract (sha256 `1cc3058cecb5...` for this release) by the same pipeline as the SDKs.
176
+ - It is generated from the Desktop Accounting API contract (sha256 `b5774d24bc81...` for this release) by the same pipeline as the SDKs.
175
177
  - Every release is listed in [CHANGELOG.md](CHANGELOG.md) and tagged `v<version>` on GitHub.
176
178
 
177
179
  ## Support
package/dist/catalog.js CHANGED
@@ -1,5 +1,5 @@
1
1
  // Code generated by packages/sdk-generator from packages/mcp/src. DO NOT EDIT.
2
- // Contract: packages/api-contract/generated/openapi.json (OpenAPI 3.1.0) sha256:1cc3058cecb557ce1cc724d5236d36860df6bec39636e2d427c8a408bf5f2ca2
2
+ // Contract: packages/api-contract/generated/openapi.json (OpenAPI 3.1.0) sha256:b5774d24bc8154ccc2acb85370ae27581a072c3f5070a529111ee2dd26f103b9
3
3
  // MCP endpoint catalog: a compact, input-only view of the public OpenAPI contract that the MCP
4
4
  // tools search, describe and invoke. Built from packages/api-contract/generated/openapi.json by
5
5
  // scripts/api-contract.mjs (committed as packages/mcp/generated/catalog.json, drift-checked) and