node-autotask 0.69.1 → 0.71.0
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 +30 -0
- package/MCP_TOOL_CATALOG.json +369 -9
- package/README.md +7 -1
- package/capabilities.json +1697 -392
- package/dist/capabilities-data.js +1696 -391
- package/dist/capabilities.cjs +4 -4
- package/dist/capabilities.js +1 -1
- package/dist/{chunk-WFVLF7EW.cjs → chunk-4DSLRDIF.cjs} +33 -30
- package/dist/{chunk-FK37JXSJ.js → chunk-4OR3XBIP.js} +699 -168
- package/dist/{chunk-MMGO3SFL.js → chunk-5COLIVBE.js} +2 -2
- package/dist/{chunk-KAZE4WC7.cjs → chunk-JLCHKCEB.cjs} +3 -3
- package/dist/{chunk-SCFB5MF3.js → chunk-LKJA57CH.js} +3 -3
- package/dist/{chunk-EWXRFHPP.cjs → chunk-QJ327YI6.cjs} +177 -177
- package/dist/{chunk-CLHDTYWO.cjs → chunk-QQFF7X67.cjs} +704 -172
- package/dist/{chunk-64BMSXWT.js → chunk-YKQ2KNQO.js} +5 -2
- package/dist/{index-BT_0tTPS.d.cts → index-CAXT5ZKT.d.cts} +14 -4
- package/dist/{index-COQEG55Q.d.cts → index-CM_SRgtH.d.cts} +209 -1
- package/dist/{index-COQEG55Q.d.ts → index-CM_SRgtH.d.ts} +209 -1
- package/dist/{index-Coe7LFLY.d.ts → index-lGpxr4gY.d.ts} +14 -4
- package/dist/index.cjs +84 -84
- package/dist/index.d.cts +3 -3
- package/dist/index.d.ts +3 -3
- package/dist/index.js +5 -5
- package/dist/operations/index.cjs +54 -50
- package/dist/operations/index.d.cts +25 -7
- package/dist/operations/index.d.ts +25 -7
- package/dist/operations/index.js +2 -2
- package/dist/pool.cjs +12 -12
- package/dist/pool.d.cts +1 -1
- package/dist/pool.d.ts +1 -1
- package/dist/pool.js +4 -4
- package/dist/resources/index.cjs +27 -27
- package/dist/resources/index.d.cts +2 -2
- package/dist/resources/index.d.ts +2 -2
- package/dist/resources/index.js +3 -3
- package/dist/types/index.d.cts +1 -1
- package/dist/types/index.d.ts +1 -1
- package/docs/API.md +108 -2
- package/docs/N8N-ADAPTER.md +1 -1
- package/docs/RELEASING.md +11 -3
- package/docs/performance-caching.md +92 -0
- package/docs/performance-reads.md +9 -1
- package/package.json +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -7,6 +7,36 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
|
|
7
7
|
|
|
8
8
|
## [Unreleased]
|
|
9
9
|
|
|
10
|
+
## [0.71.0] - 2026-11-18
|
|
11
|
+
|
|
12
|
+
### Added
|
|
13
|
+
|
|
14
|
+
- Add `attachmentInfo` reads and company/company-note attachment query, count, scoped get/create/delete and documented metadata through the existing generic resource and governed invocation paths (#467, #464). Keep note-parent and company scope distinct, expose object-specific query examples and preserve model-shaped attachment reads/deletes. Attachment updates remain unsupported.
|
|
15
|
+
|
|
16
|
+
### Changed
|
|
17
|
+
|
|
18
|
+
- Refuse `companyAttachments.createIfNotExists`: company-level query results can include child-note attachments and cannot establish exact company-parent duplicates. Use explicit scoped create instead (#467, #464).
|
|
19
|
+
- Prevent direct `createIfNotExists` calls from issuing requests on generic resources that explicitly disable creation, including read-only `attachmentInfo`. Existing compositions on create-capable resources retain their behavior (#467, #464).
|
|
20
|
+
|
|
21
|
+
### Fixed
|
|
22
|
+
|
|
23
|
+
- Identify configuration-item DNS-record parents by the documented `installedProductID` field in relationships and query guidance, so scope consumers can validate the actual model field (#471).
|
|
24
|
+
|
|
25
|
+
### Maintenance
|
|
26
|
+
|
|
27
|
+
- Account for every vendored specification route in the capabilities gate, with explicit equivalent and tracked-exclusion evidence, including entirely omitted resource families (#463).
|
|
28
|
+
|
|
29
|
+
## [0.70.0] - 2026-11-17
|
|
30
|
+
|
|
31
|
+
### Added
|
|
32
|
+
|
|
33
|
+
- Add `invokeReadPages` on the existing operations subpath for governed explicit bounded query walks (#459). Await page consumers for backpressure and return terminal completeness metadata without collecting all rows. Share invocation validation/scope admission and the bounded cursor engine with ordinary reads; preserve per-page labels, note handling, caps, continuation bodies, typed failures and cancellation through the final callback. No new MCP operation or query cache is introduced.
|
|
34
|
+
|
|
35
|
+
### Changed
|
|
36
|
+
|
|
37
|
+
- Reuse bounded metadata projections within the exact cache entry for live field authority, catalog views, picklist labels and ticket-status semantics (#459). Preserve raw/projected subscriber sharing, independent values and cancellation, fresh/invalidation/epoch behavior, older cache/reader fallbacks and cache-off behavior. Derived variants do not extend metadata lifetime.
|
|
38
|
+
- Retain existing ordinary/reference/metadata TTLs and defer general query/report response caching (#459). Document the missing hit-rate/external-change evidence and required freshness, permission, key, completeness and budget contracts rather than silently extending staleness.
|
|
39
|
+
|
|
10
40
|
## [0.69.1] - 2026-11-17
|
|
11
41
|
|
|
12
42
|
### Changed
|
package/MCP_TOOL_CATALOG.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"generatedBy": "scripts/build-tool-catalog.mjs",
|
|
3
|
-
"generatedAt": "2026-11-
|
|
4
|
-
"planHash": "
|
|
3
|
+
"generatedAt": "2026-11-18T09:40:50.612Z",
|
|
4
|
+
"planHash": "275fdf2fd6712f9384c1a65f98c5faf1fda9695475ffbdf35c08e574c18b4157",
|
|
5
5
|
"metaTools": [
|
|
6
6
|
{
|
|
7
7
|
"name": "autotask_catalog",
|
|
@@ -51,7 +51,7 @@
|
|
|
51
51
|
{
|
|
52
52
|
"name": "autotask_read",
|
|
53
53
|
"title": "Read One Registry Operation (read mode)",
|
|
54
|
-
"description": "Route an effect=read registry operation by its exact name (never fuzzy, never a tool name): the
|
|
54
|
+
"description": "Route an effect=read registry operation by its exact name (never fuzzy, never a tool name): the 397 field/entity/UDF-info reads (getEntityInfo/getFieldInfo/getUdfInfo) have no dedicated tool and ride this one, and any read op is routable. For field discovery use operations.fieldCatalog (compact) instead of per-resource getFieldInfo (full dump). Read-only by construction — every op it can route is effect=read (zero mutating requests), and a write or delete op is refused BEFORE any request (cross-mode refusal; the message names the correct tool). Reads have no dry run (a read with dry_run: true is refused). Harness approval policy: approve every tool with readOnlyHint !== true (exactly 256 today); the 620 readOnlyHint: true tools — including this one — are safe ungated; the 59 destructiveHint: true tools (58 dedicated delete tools + autotask_delete) require confirm === the operation key. Migration: autotask_invoke is REPLACED by autotask_read/autotask_write/autotask_delete — update harness config. For query/count ops args[0] is a params object (filter/limit); call autotask_describe first for the exact arg shape and filter grammar. The argument set is CLOSED at the top level: an unknown argument is refused before any request, with a typed error naming the key and the valid keys.",
|
|
55
55
|
"input": {
|
|
56
56
|
"operation": {
|
|
57
57
|
"type": "string",
|
|
@@ -71,7 +71,7 @@
|
|
|
71
71
|
{
|
|
72
72
|
"name": "autotask_write",
|
|
73
73
|
"title": "Write One Registry Operation (write mode)",
|
|
74
|
-
"description": "Route an effect=write registry operation by its exact name (never fuzzy, never a tool name), dry-run-first: the first call always travels dry_run: true (the pinned DryRunResult envelope, simulated: true — the mutating request is never issued); pass dry_run: false to apply. A read or delete op is refused BEFORE any request (cross-mode refusal; the message names the correct tool). The 2 approval-gated writes (configuration_items.moveConfigurationItem, contacts.moveToCompany) additionally require confirm === the operation key, in BOTH dry-run and apply mode. Harness approval policy: this tool is one of the
|
|
74
|
+
"description": "Route an effect=write registry operation by its exact name (never fuzzy, never a tool name), dry-run-first: the first call always travels dry_run: true (the pinned DryRunResult envelope, simulated: true — the mutating request is never issued); pass dry_run: false to apply. A read or delete op is refused BEFORE any request (cross-mode refusal; the message names the correct tool). The 2 approval-gated writes (configuration_items.moveConfigurationItem, contacts.moveToCompany) additionally require confirm === the operation key, in BOTH dry-run and apply mode. Harness approval policy: this tool is one of the 256 tools that require approval (readOnlyHint !== true); the 620 readOnlyHint: true tools are safe ungated, and the 59 destructiveHint: true tools (58 dedicated delete tools + autotask_delete) require confirm === the operation key. Migration: autotask_invoke is REPLACED by autotask_read/autotask_write/autotask_delete — update harness config. For query/count ops args[0] is a params object (filter/limit); call autotask_describe first for the exact arg shape and filter grammar. The argument set is CLOSED at the top level: an unknown argument is refused before any request, with a typed error naming the key and the valid keys.",
|
|
75
75
|
"input": {
|
|
76
76
|
"operation": {
|
|
77
77
|
"type": "string",
|
|
@@ -101,7 +101,7 @@
|
|
|
101
101
|
{
|
|
102
102
|
"name": "autotask_delete",
|
|
103
103
|
"title": "Delete One Registry Operation (delete mode)",
|
|
104
|
-
"description": "Route an effect=destructive (delete) registry operation by its exact name (never fuzzy, never a tool name), dry-run-first: the first call always travels dry_run: true (the pinned DryRunResult envelope, simulated: true); pass dry_run: false to apply. confirm === the operation key is REQUIRED for every delete (all
|
|
104
|
+
"description": "Route an effect=destructive (delete) registry operation by its exact name (never fuzzy, never a tool name), dry-run-first: the first call always travels dry_run: true (the pinned DryRunResult envelope, simulated: true); pass dry_run: false to apply. confirm === the operation key is REQUIRED for every delete (all 58), in BOTH dry-run and apply mode — the deliberate act is the call, not the delete. A read or write op is refused BEFORE any request (cross-mode refusal; the message names the correct tool). Harness approval policy: this tool is one of the 59 destructiveHint: true tools that require approval + confirm; approve every tool with readOnlyHint !== true (exactly 256 today); the 620 readOnlyHint: true tools are safe ungated. Migration: autotask_invoke is REPLACED by autotask_read/autotask_write/autotask_delete — update harness config. The argument set is CLOSED at the top level: an unknown argument is refused before any request, with a typed error naming the key and the valid keys.",
|
|
105
105
|
"input": {
|
|
106
106
|
"operation": {
|
|
107
107
|
"type": "string",
|
|
@@ -12097,6 +12097,110 @@
|
|
|
12097
12097
|
"reachReason": null,
|
|
12098
12098
|
"boundedAlternative": null
|
|
12099
12099
|
},
|
|
12100
|
+
{
|
|
12101
|
+
"operation": "attachment_info.count",
|
|
12102
|
+
"core": false,
|
|
12103
|
+
"tool": "autotask_attachmentInfo_count",
|
|
12104
|
+
"purpose": "Count attachment information records matching a JSON filter.",
|
|
12105
|
+
"preferredWhen": null,
|
|
12106
|
+
"backingOperation": "attachment_info.count",
|
|
12107
|
+
"effect": "read",
|
|
12108
|
+
"dryRunFirst": false,
|
|
12109
|
+
"confirm": false,
|
|
12110
|
+
"requiredArgs": [],
|
|
12111
|
+
"tier": "extended",
|
|
12112
|
+
"reachable": true,
|
|
12113
|
+
"reach": "dedicated tool",
|
|
12114
|
+
"reachReason": null,
|
|
12115
|
+
"boundedAlternative": null
|
|
12116
|
+
},
|
|
12117
|
+
{
|
|
12118
|
+
"operation": "attachment_info.get",
|
|
12119
|
+
"core": false,
|
|
12120
|
+
"tool": "autotask_attachmentInfo_get",
|
|
12121
|
+
"purpose": "Get one AttachmentInfo by id.",
|
|
12122
|
+
"preferredWhen": "Use a known attachment id; query attachment_info with an object-specific filter to discover ids.",
|
|
12123
|
+
"backingOperation": "attachment_info.get",
|
|
12124
|
+
"effect": "read",
|
|
12125
|
+
"dryRunFirst": false,
|
|
12126
|
+
"confirm": false,
|
|
12127
|
+
"requiredArgs": [
|
|
12128
|
+
"id"
|
|
12129
|
+
],
|
|
12130
|
+
"tier": "extended",
|
|
12131
|
+
"reachable": true,
|
|
12132
|
+
"reach": "dedicated tool",
|
|
12133
|
+
"reachReason": null,
|
|
12134
|
+
"boundedAlternative": null
|
|
12135
|
+
},
|
|
12136
|
+
{
|
|
12137
|
+
"operation": "attachment_info.getEntityInfo",
|
|
12138
|
+
"core": false,
|
|
12139
|
+
"tool": null,
|
|
12140
|
+
"purpose": "Get the AttachmentInfo capability metadata (canCreate/canUpdate/hasUserDefinedFields/...).",
|
|
12141
|
+
"preferredWhen": null,
|
|
12142
|
+
"backingOperation": "attachment_info.getEntityInfo",
|
|
12143
|
+
"effect": "read",
|
|
12144
|
+
"dryRunFirst": false,
|
|
12145
|
+
"confirm": false,
|
|
12146
|
+
"requiredArgs": [],
|
|
12147
|
+
"tier": "extended",
|
|
12148
|
+
"reachable": true,
|
|
12149
|
+
"reach": "autotask_read (exact operation name; effect=read — read-only; zero mutating requests)",
|
|
12150
|
+
"reachReason": "no dedicated tool — the op is still discoverable and invocable by exact name",
|
|
12151
|
+
"boundedAlternative": null
|
|
12152
|
+
},
|
|
12153
|
+
{
|
|
12154
|
+
"operation": "attachment_info.getFieldInfo",
|
|
12155
|
+
"core": false,
|
|
12156
|
+
"tool": null,
|
|
12157
|
+
"purpose": "Get the AttachmentInfo field catalog (types, picklists, required, maxLength) — the full raw field dump (the largest read of the info trio; compact discovery: operations.fieldCatalog).",
|
|
12158
|
+
"preferredWhen": null,
|
|
12159
|
+
"backingOperation": "attachment_info.getFieldInfo",
|
|
12160
|
+
"effect": "read",
|
|
12161
|
+
"dryRunFirst": false,
|
|
12162
|
+
"confirm": false,
|
|
12163
|
+
"requiredArgs": [],
|
|
12164
|
+
"tier": "extended",
|
|
12165
|
+
"reachable": true,
|
|
12166
|
+
"reach": "autotask_read (exact operation name; effect=read — read-only; zero mutating requests)",
|
|
12167
|
+
"reachReason": "no dedicated tool — the op is still discoverable and invocable by exact name",
|
|
12168
|
+
"boundedAlternative": null
|
|
12169
|
+
},
|
|
12170
|
+
{
|
|
12171
|
+
"operation": "attachment_info.getUdfInfo",
|
|
12172
|
+
"core": false,
|
|
12173
|
+
"tool": null,
|
|
12174
|
+
"purpose": "Get the AttachmentInfo user-defined-field catalog.",
|
|
12175
|
+
"preferredWhen": null,
|
|
12176
|
+
"backingOperation": "attachment_info.getUdfInfo",
|
|
12177
|
+
"effect": "read",
|
|
12178
|
+
"dryRunFirst": false,
|
|
12179
|
+
"confirm": false,
|
|
12180
|
+
"requiredArgs": [],
|
|
12181
|
+
"tier": "extended",
|
|
12182
|
+
"reachable": true,
|
|
12183
|
+
"reach": "autotask_read (exact operation name; effect=read — read-only; zero mutating requests)",
|
|
12184
|
+
"reachReason": "no dedicated tool — the op is still discoverable and invocable by exact name",
|
|
12185
|
+
"boundedAlternative": null
|
|
12186
|
+
},
|
|
12187
|
+
{
|
|
12188
|
+
"operation": "attachment_info.query",
|
|
12189
|
+
"core": false,
|
|
12190
|
+
"tool": "autotask_attachmentInfo_query",
|
|
12191
|
+
"purpose": "Query AttachmentInfo records with a JSON filter.",
|
|
12192
|
+
"preferredWhen": "Default for filtered reads (the bounded query op). queryAll is the unbounded raw walk — only when you need the ENTIRE set and accept a large payload; default to the bounded query op. Prefer an includeFields subset over the full model (field names via operations.fieldCatalog). latest: N is the latest-N rows (id-descending) when the newest rows are the goal (the vendor has no sort — count-anchored, docs/API.md §4). Prefer a hand-listed includeFields for common narrow reads (removed the closed fieldsPreset presets — the v1 billing_join field list for billing_items.query, if you need it, is: companyID, ticketID, projectID, timeEntryID, contractServiceID, contractID, billingCodeID, expenseItemID, itemDate, quantity, rate, extendedPrice, totalAmount, nonBillable); noteChars: N caps the untrusted-class free-text fields of the resource (notes/descriptions/UDF prose) to N chars each with the explicit … [+N chars truncated] marker (opt-in; the raw result when absent).",
|
|
12193
|
+
"backingOperation": "attachment_info.query",
|
|
12194
|
+
"effect": "read",
|
|
12195
|
+
"dryRunFirst": false,
|
|
12196
|
+
"confirm": false,
|
|
12197
|
+
"requiredArgs": [],
|
|
12198
|
+
"tier": "extended",
|
|
12199
|
+
"reachable": true,
|
|
12200
|
+
"reach": "dedicated tool",
|
|
12201
|
+
"reachReason": null,
|
|
12202
|
+
"boundedAlternative": null
|
|
12203
|
+
},
|
|
12100
12204
|
{
|
|
12101
12205
|
"operation": "companies.count",
|
|
12102
12206
|
"core": false,
|
|
@@ -12596,6 +12700,134 @@
|
|
|
12596
12700
|
"reachReason": null,
|
|
12597
12701
|
"boundedAlternative": null
|
|
12598
12702
|
},
|
|
12703
|
+
{
|
|
12704
|
+
"operation": "company_attachments.count",
|
|
12705
|
+
"core": false,
|
|
12706
|
+
"tool": "autotask_companyAttachment_count",
|
|
12707
|
+
"purpose": "Count attachment records matching a JSON filter. (under a company)",
|
|
12708
|
+
"preferredWhen": null,
|
|
12709
|
+
"backingOperation": "company_attachments.count",
|
|
12710
|
+
"effect": "read",
|
|
12711
|
+
"dryRunFirst": false,
|
|
12712
|
+
"confirm": false,
|
|
12713
|
+
"requiredArgs": [],
|
|
12714
|
+
"tier": "extended",
|
|
12715
|
+
"reachable": true,
|
|
12716
|
+
"reach": "dedicated tool",
|
|
12717
|
+
"reachReason": null,
|
|
12718
|
+
"boundedAlternative": null
|
|
12719
|
+
},
|
|
12720
|
+
{
|
|
12721
|
+
"operation": "company_attachments.create",
|
|
12722
|
+
"core": false,
|
|
12723
|
+
"tool": "autotask_companyAttachment_create",
|
|
12724
|
+
"purpose": "Create an attachment. (under a company)",
|
|
12725
|
+
"preferredWhen": "Add a new attachment; existing attachments cannot be updated. Replace through separately governed delete and create actions.",
|
|
12726
|
+
"backingOperation": "company_attachments.create",
|
|
12727
|
+
"effect": "write",
|
|
12728
|
+
"dryRunFirst": true,
|
|
12729
|
+
"confirm": false,
|
|
12730
|
+
"requiredArgs": [
|
|
12731
|
+
"parentId",
|
|
12732
|
+
"data"
|
|
12733
|
+
],
|
|
12734
|
+
"tier": "extended",
|
|
12735
|
+
"reachable": true,
|
|
12736
|
+
"reach": "dedicated tool",
|
|
12737
|
+
"reachReason": null,
|
|
12738
|
+
"boundedAlternative": null
|
|
12739
|
+
},
|
|
12740
|
+
{
|
|
12741
|
+
"operation": "company_attachments.delete",
|
|
12742
|
+
"core": false,
|
|
12743
|
+
"tool": "autotask_companyAttachment_delete",
|
|
12744
|
+
"purpose": "Delete an attachment. (under a company)",
|
|
12745
|
+
"preferredWhen": null,
|
|
12746
|
+
"backingOperation": "company_attachments.delete",
|
|
12747
|
+
"effect": "destructive",
|
|
12748
|
+
"dryRunFirst": true,
|
|
12749
|
+
"confirm": true,
|
|
12750
|
+
"requiredArgs": [
|
|
12751
|
+
"parentId",
|
|
12752
|
+
"id"
|
|
12753
|
+
],
|
|
12754
|
+
"tier": "extended",
|
|
12755
|
+
"reachable": true,
|
|
12756
|
+
"reach": "dedicated tool",
|
|
12757
|
+
"reachReason": null,
|
|
12758
|
+
"boundedAlternative": null
|
|
12759
|
+
},
|
|
12760
|
+
{
|
|
12761
|
+
"operation": "company_attachments.get",
|
|
12762
|
+
"core": false,
|
|
12763
|
+
"tool": "autotask_companyAttachment_get",
|
|
12764
|
+
"purpose": "Get one CompanyAttachment by id.",
|
|
12765
|
+
"preferredWhen": "Use a known attachment id; query the scoped collection to discover ids.",
|
|
12766
|
+
"backingOperation": "company_attachments.get",
|
|
12767
|
+
"effect": "read",
|
|
12768
|
+
"dryRunFirst": false,
|
|
12769
|
+
"confirm": false,
|
|
12770
|
+
"requiredArgs": [
|
|
12771
|
+
"parentId",
|
|
12772
|
+
"id"
|
|
12773
|
+
],
|
|
12774
|
+
"tier": "extended",
|
|
12775
|
+
"reachable": true,
|
|
12776
|
+
"reach": "dedicated tool",
|
|
12777
|
+
"reachReason": null,
|
|
12778
|
+
"boundedAlternative": null
|
|
12779
|
+
},
|
|
12780
|
+
{
|
|
12781
|
+
"operation": "company_attachments.getEntityInfo",
|
|
12782
|
+
"core": false,
|
|
12783
|
+
"tool": null,
|
|
12784
|
+
"purpose": "Get the CompanyAttachment capability metadata (canCreate/canUpdate/hasUserDefinedFields/...).",
|
|
12785
|
+
"preferredWhen": null,
|
|
12786
|
+
"backingOperation": "company_attachments.getEntityInfo",
|
|
12787
|
+
"effect": "read",
|
|
12788
|
+
"dryRunFirst": false,
|
|
12789
|
+
"confirm": false,
|
|
12790
|
+
"requiredArgs": [],
|
|
12791
|
+
"tier": "extended",
|
|
12792
|
+
"reachable": true,
|
|
12793
|
+
"reach": "autotask_read (exact operation name; effect=read — read-only; zero mutating requests)",
|
|
12794
|
+
"reachReason": "no dedicated tool — the op is still discoverable and invocable by exact name",
|
|
12795
|
+
"boundedAlternative": null
|
|
12796
|
+
},
|
|
12797
|
+
{
|
|
12798
|
+
"operation": "company_attachments.getFieldInfo",
|
|
12799
|
+
"core": false,
|
|
12800
|
+
"tool": null,
|
|
12801
|
+
"purpose": "Get the CompanyAttachment field catalog (types, picklists, required, maxLength) — the full raw field dump (the largest read of the info trio; compact discovery: operations.fieldCatalog).",
|
|
12802
|
+
"preferredWhen": null,
|
|
12803
|
+
"backingOperation": "company_attachments.getFieldInfo",
|
|
12804
|
+
"effect": "read",
|
|
12805
|
+
"dryRunFirst": false,
|
|
12806
|
+
"confirm": false,
|
|
12807
|
+
"requiredArgs": [],
|
|
12808
|
+
"tier": "extended",
|
|
12809
|
+
"reachable": true,
|
|
12810
|
+
"reach": "autotask_read (exact operation name; effect=read — read-only; zero mutating requests)",
|
|
12811
|
+
"reachReason": "no dedicated tool — the op is still discoverable and invocable by exact name",
|
|
12812
|
+
"boundedAlternative": null
|
|
12813
|
+
},
|
|
12814
|
+
{
|
|
12815
|
+
"operation": "company_attachments.query",
|
|
12816
|
+
"core": false,
|
|
12817
|
+
"tool": "autotask_companyAttachment_query",
|
|
12818
|
+
"purpose": "Query CompanyAttachment records with a JSON filter.",
|
|
12819
|
+
"preferredWhen": "Default for filtered reads (the bounded query op). queryAll is the unbounded raw walk — only when you need the ENTIRE set and accept a large payload; default to the bounded query op. Prefer an includeFields subset over the full model (field names via operations.fieldCatalog). latest: N is the latest-N rows (id-descending) when the newest rows are the goal (the vendor has no sort — count-anchored, docs/API.md §4). Prefer a hand-listed includeFields for common narrow reads (removed the closed fieldsPreset presets — the v1 billing_join field list for billing_items.query, if you need it, is: companyID, ticketID, projectID, timeEntryID, contractServiceID, contractID, billingCodeID, expenseItemID, itemDate, quantity, rate, extendedPrice, totalAmount, nonBillable); noteChars: N caps the untrusted-class free-text fields of the resource (notes/descriptions/UDF prose) to N chars each with the explicit … [+N chars truncated] marker (opt-in; the raw result when absent).",
|
|
12820
|
+
"backingOperation": "company_attachments.query",
|
|
12821
|
+
"effect": "read",
|
|
12822
|
+
"dryRunFirst": false,
|
|
12823
|
+
"confirm": false,
|
|
12824
|
+
"requiredArgs": [],
|
|
12825
|
+
"tier": "extended",
|
|
12826
|
+
"reachable": true,
|
|
12827
|
+
"reach": "dedicated tool",
|
|
12828
|
+
"reachReason": null,
|
|
12829
|
+
"boundedAlternative": null
|
|
12830
|
+
},
|
|
12599
12831
|
{
|
|
12600
12832
|
"operation": "company_locations.count",
|
|
12601
12833
|
"core": false,
|
|
@@ -12800,6 +13032,134 @@
|
|
|
12800
13032
|
"reachReason": null,
|
|
12801
13033
|
"boundedAlternative": null
|
|
12802
13034
|
},
|
|
13035
|
+
{
|
|
13036
|
+
"operation": "company_note_attachments.count",
|
|
13037
|
+
"core": false,
|
|
13038
|
+
"tool": "autotask_companyNoteAttachment_count",
|
|
13039
|
+
"purpose": "Count attachment records matching a JSON filter. (under a company note)",
|
|
13040
|
+
"preferredWhen": null,
|
|
13041
|
+
"backingOperation": "company_note_attachments.count",
|
|
13042
|
+
"effect": "read",
|
|
13043
|
+
"dryRunFirst": false,
|
|
13044
|
+
"confirm": false,
|
|
13045
|
+
"requiredArgs": [],
|
|
13046
|
+
"tier": "extended",
|
|
13047
|
+
"reachable": true,
|
|
13048
|
+
"reach": "dedicated tool",
|
|
13049
|
+
"reachReason": null,
|
|
13050
|
+
"boundedAlternative": null
|
|
13051
|
+
},
|
|
13052
|
+
{
|
|
13053
|
+
"operation": "company_note_attachments.create",
|
|
13054
|
+
"core": false,
|
|
13055
|
+
"tool": "autotask_companyNoteAttachment_create",
|
|
13056
|
+
"purpose": "Create an attachment. (under a company note)",
|
|
13057
|
+
"preferredWhen": "Add a new attachment; existing attachments cannot be updated. Replace through separately governed delete and create actions.",
|
|
13058
|
+
"backingOperation": "company_note_attachments.create",
|
|
13059
|
+
"effect": "write",
|
|
13060
|
+
"dryRunFirst": true,
|
|
13061
|
+
"confirm": false,
|
|
13062
|
+
"requiredArgs": [
|
|
13063
|
+
"parentId",
|
|
13064
|
+
"data"
|
|
13065
|
+
],
|
|
13066
|
+
"tier": "extended",
|
|
13067
|
+
"reachable": true,
|
|
13068
|
+
"reach": "dedicated tool",
|
|
13069
|
+
"reachReason": null,
|
|
13070
|
+
"boundedAlternative": null
|
|
13071
|
+
},
|
|
13072
|
+
{
|
|
13073
|
+
"operation": "company_note_attachments.delete",
|
|
13074
|
+
"core": false,
|
|
13075
|
+
"tool": "autotask_companyNoteAttachment_delete",
|
|
13076
|
+
"purpose": "Delete an attachment. (under a company note)",
|
|
13077
|
+
"preferredWhen": null,
|
|
13078
|
+
"backingOperation": "company_note_attachments.delete",
|
|
13079
|
+
"effect": "destructive",
|
|
13080
|
+
"dryRunFirst": true,
|
|
13081
|
+
"confirm": true,
|
|
13082
|
+
"requiredArgs": [
|
|
13083
|
+
"parentId",
|
|
13084
|
+
"id"
|
|
13085
|
+
],
|
|
13086
|
+
"tier": "extended",
|
|
13087
|
+
"reachable": true,
|
|
13088
|
+
"reach": "dedicated tool",
|
|
13089
|
+
"reachReason": null,
|
|
13090
|
+
"boundedAlternative": null
|
|
13091
|
+
},
|
|
13092
|
+
{
|
|
13093
|
+
"operation": "company_note_attachments.get",
|
|
13094
|
+
"core": false,
|
|
13095
|
+
"tool": "autotask_companyNoteAttachment_get",
|
|
13096
|
+
"purpose": "Get one CompanyNoteAttachment by id.",
|
|
13097
|
+
"preferredWhen": "Use a known attachment id; query the scoped collection to discover ids.",
|
|
13098
|
+
"backingOperation": "company_note_attachments.get",
|
|
13099
|
+
"effect": "read",
|
|
13100
|
+
"dryRunFirst": false,
|
|
13101
|
+
"confirm": false,
|
|
13102
|
+
"requiredArgs": [
|
|
13103
|
+
"parentId",
|
|
13104
|
+
"id"
|
|
13105
|
+
],
|
|
13106
|
+
"tier": "extended",
|
|
13107
|
+
"reachable": true,
|
|
13108
|
+
"reach": "dedicated tool",
|
|
13109
|
+
"reachReason": null,
|
|
13110
|
+
"boundedAlternative": null
|
|
13111
|
+
},
|
|
13112
|
+
{
|
|
13113
|
+
"operation": "company_note_attachments.getEntityInfo",
|
|
13114
|
+
"core": false,
|
|
13115
|
+
"tool": null,
|
|
13116
|
+
"purpose": "Get the CompanyNoteAttachment capability metadata (canCreate/canUpdate/hasUserDefinedFields/...).",
|
|
13117
|
+
"preferredWhen": null,
|
|
13118
|
+
"backingOperation": "company_note_attachments.getEntityInfo",
|
|
13119
|
+
"effect": "read",
|
|
13120
|
+
"dryRunFirst": false,
|
|
13121
|
+
"confirm": false,
|
|
13122
|
+
"requiredArgs": [],
|
|
13123
|
+
"tier": "extended",
|
|
13124
|
+
"reachable": true,
|
|
13125
|
+
"reach": "autotask_read (exact operation name; effect=read — read-only; zero mutating requests)",
|
|
13126
|
+
"reachReason": "no dedicated tool — the op is still discoverable and invocable by exact name",
|
|
13127
|
+
"boundedAlternative": null
|
|
13128
|
+
},
|
|
13129
|
+
{
|
|
13130
|
+
"operation": "company_note_attachments.getFieldInfo",
|
|
13131
|
+
"core": false,
|
|
13132
|
+
"tool": null,
|
|
13133
|
+
"purpose": "Get the CompanyNoteAttachment field catalog (types, picklists, required, maxLength) — the full raw field dump (the largest read of the info trio; compact discovery: operations.fieldCatalog).",
|
|
13134
|
+
"preferredWhen": null,
|
|
13135
|
+
"backingOperation": "company_note_attachments.getFieldInfo",
|
|
13136
|
+
"effect": "read",
|
|
13137
|
+
"dryRunFirst": false,
|
|
13138
|
+
"confirm": false,
|
|
13139
|
+
"requiredArgs": [],
|
|
13140
|
+
"tier": "extended",
|
|
13141
|
+
"reachable": true,
|
|
13142
|
+
"reach": "autotask_read (exact operation name; effect=read — read-only; zero mutating requests)",
|
|
13143
|
+
"reachReason": "no dedicated tool — the op is still discoverable and invocable by exact name",
|
|
13144
|
+
"boundedAlternative": null
|
|
13145
|
+
},
|
|
13146
|
+
{
|
|
13147
|
+
"operation": "company_note_attachments.query",
|
|
13148
|
+
"core": false,
|
|
13149
|
+
"tool": "autotask_companyNoteAttachment_query",
|
|
13150
|
+
"purpose": "Query CompanyNoteAttachment records with a JSON filter.",
|
|
13151
|
+
"preferredWhen": "Default for filtered reads (the bounded query op). queryAll is the unbounded raw walk — only when you need the ENTIRE set and accept a large payload; default to the bounded query op. Prefer an includeFields subset over the full model (field names via operations.fieldCatalog). latest: N is the latest-N rows (id-descending) when the newest rows are the goal (the vendor has no sort — count-anchored, docs/API.md §4). Prefer a hand-listed includeFields for common narrow reads (removed the closed fieldsPreset presets — the v1 billing_join field list for billing_items.query, if you need it, is: companyID, ticketID, projectID, timeEntryID, contractServiceID, contractID, billingCodeID, expenseItemID, itemDate, quantity, rate, extendedPrice, totalAmount, nonBillable); noteChars: N caps the untrusted-class free-text fields of the resource (notes/descriptions/UDF prose) to N chars each with the explicit … [+N chars truncated] marker (opt-in; the raw result when absent).",
|
|
13152
|
+
"backingOperation": "company_note_attachments.query",
|
|
13153
|
+
"effect": "read",
|
|
13154
|
+
"dryRunFirst": false,
|
|
13155
|
+
"confirm": false,
|
|
13156
|
+
"requiredArgs": [],
|
|
13157
|
+
"tier": "extended",
|
|
13158
|
+
"reachable": true,
|
|
13159
|
+
"reach": "dedicated tool",
|
|
13160
|
+
"reachReason": null,
|
|
13161
|
+
"boundedAlternative": null
|
|
13162
|
+
},
|
|
12803
13163
|
{
|
|
12804
13164
|
"operation": "company_notes.count",
|
|
12805
13165
|
"core": false,
|
|
@@ -22958,11 +23318,11 @@
|
|
|
22958
23318
|
}
|
|
22959
23319
|
],
|
|
22960
23320
|
"counts": {
|
|
22961
|
-
"registryOperations":
|
|
23321
|
+
"registryOperations": 1268,
|
|
22962
23322
|
"coreOperations": 10,
|
|
22963
|
-
"catalogRows":
|
|
22964
|
-
"withTool":
|
|
22965
|
-
"readModeOnly":
|
|
23323
|
+
"catalogRows": 1268,
|
|
23324
|
+
"withTool": 871,
|
|
23325
|
+
"readModeOnly": 397,
|
|
22966
23326
|
"neverExposed": 0,
|
|
22967
23327
|
"metaTools": 5
|
|
22968
23328
|
}
|
package/README.md
CHANGED
|
@@ -227,6 +227,12 @@ consumes hourly admission and the applicable object-thread limit.
|
|
|
227
227
|
The [vendor threshold reference](https://www.autotask.net/help/developerhelp/content/apis/REST/General_Topics/REST_Thresholds_Limits.htm)
|
|
228
228
|
describes that database-wide limit.
|
|
229
229
|
|
|
230
|
+
For large governed query exports, [`invokeReadPages`](docs/API.md#74a-invokereadpages--governed-bounded-page-consumption)
|
|
231
|
+
awaits each page consumer and returns the bounded walk's terminal evidence without
|
|
232
|
+
collecting every row. Metadata-derived views reuse work within the existing cache
|
|
233
|
+
entry; [cache evaluation](docs/performance-caching.md) explains why ordinary TTLs and
|
|
234
|
+
query/report caching policy remain unchanged. Neither optimization raises API limits.
|
|
235
|
+
|
|
230
236
|
## Agent profile (conservative limits for LLM-driven servers)
|
|
231
237
|
|
|
232
238
|
`profile: 'agent'` on the config switches the SDK to conservative limits for
|
|
@@ -383,7 +389,7 @@ The SDK ships the mechanical substrate, not a server (no MCP imports, no zod):
|
|
|
383
389
|
governor place: `src/operations/invoke.ts`).
|
|
384
390
|
|
|
385
391
|
<!-- BEGIN GENERATED:approval-policy -->
|
|
386
|
-
**Harness approval policy (recommended).** Require approval on every tool whose MCP annotation is `readOnlyHint !== true` — today exactly **
|
|
392
|
+
**Harness approval policy (recommended).** Require approval on every tool whose MCP annotation is `readOnlyHint !== true` — today exactly **256 tools**: the 254 dedicated write/delete tools (196 `effect=write` + 58 `effect=destructive`, every one of them has a dedicated tool) + `autotask_write` + `autotask_delete`. The remaining **620 tools** (the 607 dedicated read tools + the 10 core read tools + `autotask_read` + `autotask_catalog` + `autotask_describe`) all carry `readOnlyHint: true` and are safe ungated: every op they can route is `effect=read` (zero mutating requests). Refined class for the highest-risk ops: the **59 tools with `destructiveHint: true`** (58 dedicated delete tools + `autotask_delete`) additionally require `confirm === <operation key>` even inside `autotask_delete`. The approval-gated writes (`configuration_items.moveConfigurationItem`, `contacts.moveToCompany`) require the same confirm inside `autotask_write`. Migration: `autotask_invoke` is REPLACED by `autotask_read`/`autotask_write`/`autotask_delete` — update harness config and remove any `autotask_invoke` entry. The rule is derivable from the registry `effect` column and the mode tools’ fixed annotations; it never needs a hand-maintained name list.
|
|
387
393
|
<!-- END GENERATED:approval-policy -->
|
|
388
394
|
**Provider tool-search interop.** Hosts with provider-native tool search
|
|
389
395
|
(OpenAI `type: "tool_search"` / `defer_loading`; Anthropic's tool search
|