kaiten-cli 0.3.3__py3-none-any.whl
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.
- kaiten_cli/__init__.py +5 -0
- kaiten_cli/__main__.py +9 -0
- kaiten_cli/agent_gateway.py +577 -0
- kaiten_cli/app.py +1636 -0
- kaiten_cli/completion.py +570 -0
- kaiten_cli/discovery.py +39 -0
- kaiten_cli/errors.py +79 -0
- kaiten_cli/i18n.py +92 -0
- kaiten_cli/locales/ru.json +2967 -0
- kaiten_cli/localized_click.py +160 -0
- kaiten_cli/models.py +202 -0
- kaiten_cli/profiles.py +316 -0
- kaiten_cli/registry/__init__.py +260 -0
- kaiten_cli/registry/addons.py +392 -0
- kaiten_cli/registry/audit_and_analytics.py +451 -0
- kaiten_cli/registry/automation_schema.py +44 -0
- kaiten_cli/registry/automation_schemas.json +7417 -0
- kaiten_cli/registry/automations.py +342 -0
- kaiten_cli/registry/base.py +62 -0
- kaiten_cli/registry/blockers.py +320 -0
- kaiten_cli/registry/boards.py +520 -0
- kaiten_cli/registry/card_relations.py +376 -0
- kaiten_cli/registry/card_types.py +363 -0
- kaiten_cli/registry/cards.py +1329 -0
- kaiten_cli/registry/charts.py +539 -0
- kaiten_cli/registry/checklists.py +600 -0
- kaiten_cli/registry/columns.py +558 -0
- kaiten_cli/registry/comments.py +224 -0
- kaiten_cli/registry/custom_directories.py +980 -0
- kaiten_cli/registry/custom_properties.py +1460 -0
- kaiten_cli/registry/dashboards.py +564 -0
- kaiten_cli/registry/documents.py +761 -0
- kaiten_cli/registry/external_links.py +128 -0
- kaiten_cli/registry/files.py +738 -0
- kaiten_cli/registry/github_addon.py +613 -0
- kaiten_cli/registry/iterations.py +397 -0
- kaiten_cli/registry/lanes.py +205 -0
- kaiten_cli/registry/live_contracts.py +361 -0
- kaiten_cli/registry/members.py +336 -0
- kaiten_cli/registry/module_docs.py +108 -0
- kaiten_cli/registry/projects.py +369 -0
- kaiten_cli/registry/query.py +129 -0
- kaiten_cli/registry/restrictions.py +249 -0
- kaiten_cli/registry/roles_and_groups.py +1102 -0
- kaiten_cli/registry/scim.py +263 -0
- kaiten_cli/registry/service_desk.py +1270 -0
- kaiten_cli/registry/snapshot.py +187 -0
- kaiten_cli/registry/spaces.py +272 -0
- kaiten_cli/registry/subscribers.py +168 -0
- kaiten_cli/registry/tags.py +193 -0
- kaiten_cli/registry/time_logs.py +353 -0
- kaiten_cli/registry/tree.py +352 -0
- kaiten_cli/registry/utilities.py +287 -0
- kaiten_cli/registry/webhooks.py +265 -0
- kaiten_cli/runtime/__init__.py +1 -0
- kaiten_cli/runtime/automation_validation.py +115 -0
- kaiten_cli/runtime/behaviors.py +787 -0
- kaiten_cli/runtime/cache.py +733 -0
- kaiten_cli/runtime/client.py +387 -0
- kaiten_cli/runtime/endpoints.py +59 -0
- kaiten_cli/runtime/executor.py +269 -0
- kaiten_cli/runtime/fs_security.py +168 -0
- kaiten_cli/runtime/input.py +310 -0
- kaiten_cli/runtime/output.py +59 -0
- kaiten_cli/runtime/public_validation.py +35 -0
- kaiten_cli/runtime/snapshot_build.py +527 -0
- kaiten_cli/runtime/snapshot_common.py +363 -0
- kaiten_cli/runtime/snapshot_query.py +306 -0
- kaiten_cli/runtime/snapshot_store.py +1192 -0
- kaiten_cli/runtime/snapshots.py +62 -0
- kaiten_cli/runtime/sqlite_errors.py +23 -0
- kaiten_cli/runtime/support/__init__.py +1 -0
- kaiten_cli/runtime/support/addons.py +953 -0
- kaiten_cli/runtime/support/audit.py +70 -0
- kaiten_cli/runtime/support/batch.py +234 -0
- kaiten_cli/runtime/support/card_move_url.py +213 -0
- kaiten_cli/runtime/support/cards.py +174 -0
- kaiten_cli/runtime/support/checklists.py +21 -0
- kaiten_cli/runtime/support/company_users.py +117 -0
- kaiten_cli/runtime/support/dashboards.py +35 -0
- kaiten_cli/runtime/support/documents.py +175 -0
- kaiten_cli/runtime/support/files.py +561 -0
- kaiten_cli/runtime/support/markdown_export.py +525 -0
- kaiten_cli/runtime/support/pagination.py +167 -0
- kaiten_cli/runtime/support/projects.py +66 -0
- kaiten_cli/runtime/support/relations.py +86 -0
- kaiten_cli/runtime/support/restrictions.py +62 -0
- kaiten_cli/runtime/support/spaces.py +20 -0
- kaiten_cli/runtime/support/time_logs.py +61 -0
- kaiten_cli/runtime/support/tree.py +140 -0
- kaiten_cli/runtime/support/tree_sharing.py +447 -0
- kaiten_cli/runtime/trace.py +500 -0
- kaiten_cli/runtime/transforms.py +128 -0
- kaiten_cli/schema_docs.py +22 -0
- kaiten_cli/update_check.py +519 -0
- kaiten_cli-0.3.3.dist-info/METADATA +1110 -0
- kaiten_cli-0.3.3.dist-info/RECORD +99 -0
- kaiten_cli-0.3.3.dist-info/WHEEL +4 -0
- kaiten_cli-0.3.3.dist-info/entry_points.txt +3 -0
|
@@ -0,0 +1,980 @@
|
|
|
1
|
+
"""Custom directory (Kaiten Catalog) tool specs."""
|
|
2
|
+
|
|
3
|
+
from __future__ import annotations
|
|
4
|
+
|
|
5
|
+
from kaiten_cli.models import ExampleSpec, OperationSpec, ResponsePolicy, RuntimeBehavior
|
|
6
|
+
from kaiten_cli.registry.base import make_tool
|
|
7
|
+
from kaiten_cli.runtime.behaviors import encode_object_query_request, payload_body_request
|
|
8
|
+
|
|
9
|
+
DIRECTORY_ID = {"type": "string", "description": "Custom directory ID (UUID)."}
|
|
10
|
+
FIELD_ID = {"type": "string", "description": "Custom directory field ID (UUID)."}
|
|
11
|
+
RECORD_ID = {"type": "string", "description": "Custom directory record ID (UUID)."}
|
|
12
|
+
CONDITIONS = {
|
|
13
|
+
"type": "array",
|
|
14
|
+
"description": 'Condition filters, for example ["active", "inactive", "removed"].',
|
|
15
|
+
}
|
|
16
|
+
PAYLOAD = {
|
|
17
|
+
"type": "object",
|
|
18
|
+
"description": "Extra JSON body fields from the Kaiten API docs. Merged into the request body.",
|
|
19
|
+
}
|
|
20
|
+
|
|
21
|
+
CATALOG_USAGE_NOTES = (
|
|
22
|
+
"Kaiten Catalogs are table-like directories exposed by the Developers API as `custom-directories`.",
|
|
23
|
+
"Use these commands for a catalog table with fields and records.",
|
|
24
|
+
"Use these commands for table/database-like catalogs with fields and records, such as clients, contacts, equipment, or contractors.",
|
|
25
|
+
"`custom-directories` manages the catalog itself, `custom-directory-fields` manages table columns, and `custom-directory-records` manages table rows.",
|
|
26
|
+
"Do not confuse this with `custom-properties catalog-values`, which manages values for custom fields of type catalog.",
|
|
27
|
+
"Do not confuse this with document folders/containers; those use `document-groups.*` and tree navigation.",
|
|
28
|
+
"If a request says only `catalog` or `directory` before a mutation, clarify whether it means a catalog table (`custom-directories`), a catalog card field (`custom-properties.*`), its values (`custom-properties catalog-values`), or document groups.",
|
|
29
|
+
"The Developers API marks custom directories, fields, and records as beta; parameters and response formats may change.",
|
|
30
|
+
)
|
|
31
|
+
|
|
32
|
+
|
|
33
|
+
TOOLS = (
|
|
34
|
+
make_tool(
|
|
35
|
+
canonical_name="custom-directories.list",
|
|
36
|
+
mcp_alias="kaiten_list_custom_directories",
|
|
37
|
+
description="List Kaiten Catalogs (custom directories).",
|
|
38
|
+
input_schema={
|
|
39
|
+
"type": "object",
|
|
40
|
+
"properties": {
|
|
41
|
+
"include_fields": {"type": "boolean", "description": "Include directory fields"},
|
|
42
|
+
"include_author": {"type": "boolean", "description": "Include author user object"},
|
|
43
|
+
"include_records_count": {
|
|
44
|
+
"type": "boolean",
|
|
45
|
+
"description": "Include records_count in each directory",
|
|
46
|
+
},
|
|
47
|
+
"query": {
|
|
48
|
+
"type": "string",
|
|
49
|
+
"description": "Search by directory name (case-insensitive)",
|
|
50
|
+
},
|
|
51
|
+
"conditions": {
|
|
52
|
+
"type": "array",
|
|
53
|
+
"description": "Filter by condition values: active | inactive | removed",
|
|
54
|
+
"items": {"type": "string"},
|
|
55
|
+
},
|
|
56
|
+
"limit": {
|
|
57
|
+
"type": "integer",
|
|
58
|
+
"description": "Max results, capped by Kaiten at 200.",
|
|
59
|
+
},
|
|
60
|
+
"offset": {"type": "integer", "description": "Pagination offset."},
|
|
61
|
+
},
|
|
62
|
+
},
|
|
63
|
+
operation=OperationSpec(
|
|
64
|
+
method="GET",
|
|
65
|
+
path_template="/company/custom-directories",
|
|
66
|
+
query_fields=(
|
|
67
|
+
"include_fields",
|
|
68
|
+
"include_author",
|
|
69
|
+
"include_records_count",
|
|
70
|
+
"query",
|
|
71
|
+
"conditions",
|
|
72
|
+
"limit",
|
|
73
|
+
"offset",
|
|
74
|
+
),
|
|
75
|
+
),
|
|
76
|
+
response_policy=ResponsePolicy(default_limit=200, result_kind="list"),
|
|
77
|
+
examples=(
|
|
78
|
+
ExampleSpec(
|
|
79
|
+
command="kaiten --json custom-directories list --include-fields --include-records-count",
|
|
80
|
+
description="List Catalogs with field metadata and record counts.",
|
|
81
|
+
),
|
|
82
|
+
),
|
|
83
|
+
search_terms=(
|
|
84
|
+
"каталог",
|
|
85
|
+
"каталоги",
|
|
86
|
+
"справочник",
|
|
87
|
+
"справочник-таблица",
|
|
88
|
+
"справочник таблица",
|
|
89
|
+
"табличный справочник",
|
|
90
|
+
),
|
|
91
|
+
usage_notes=CATALOG_USAGE_NOTES,
|
|
92
|
+
),
|
|
93
|
+
make_tool(
|
|
94
|
+
canonical_name="custom-directories.get",
|
|
95
|
+
mcp_alias="kaiten_get_custom_directory",
|
|
96
|
+
description="Get a Kaiten Catalog (custom directory).",
|
|
97
|
+
input_schema={
|
|
98
|
+
"type": "object",
|
|
99
|
+
"properties": {
|
|
100
|
+
"directory_id": DIRECTORY_ID,
|
|
101
|
+
"include_fields": {
|
|
102
|
+
"type": "boolean",
|
|
103
|
+
"description": "Include directory field definitions.",
|
|
104
|
+
},
|
|
105
|
+
"include_author": {"type": "boolean", "description": "Include author user object."},
|
|
106
|
+
"include_records_count": {
|
|
107
|
+
"type": "boolean",
|
|
108
|
+
"description": "Include records_count.",
|
|
109
|
+
},
|
|
110
|
+
},
|
|
111
|
+
"required": ["directory_id"],
|
|
112
|
+
},
|
|
113
|
+
operation=OperationSpec(
|
|
114
|
+
method="GET",
|
|
115
|
+
path_template="/company/custom-directories/{directory_id}",
|
|
116
|
+
path_fields=("directory_id",),
|
|
117
|
+
query_fields=("include_fields", "include_author", "include_records_count"),
|
|
118
|
+
),
|
|
119
|
+
examples=(
|
|
120
|
+
ExampleSpec(
|
|
121
|
+
command="kaiten --json custom-directories get --directory-id dir-uuid",
|
|
122
|
+
description="Get a Catalog.",
|
|
123
|
+
),
|
|
124
|
+
),
|
|
125
|
+
search_terms=(
|
|
126
|
+
"каталог",
|
|
127
|
+
"каталоги",
|
|
128
|
+
"справочник",
|
|
129
|
+
"справочник-таблица",
|
|
130
|
+
"справочник таблица",
|
|
131
|
+
"табличный справочник",
|
|
132
|
+
),
|
|
133
|
+
usage_notes=CATALOG_USAGE_NOTES,
|
|
134
|
+
),
|
|
135
|
+
make_tool(
|
|
136
|
+
canonical_name="custom-directories.create",
|
|
137
|
+
mcp_alias="kaiten_create_custom_directory",
|
|
138
|
+
description="Create a Kaiten Catalog (custom directory).",
|
|
139
|
+
input_schema={
|
|
140
|
+
"type": "object",
|
|
141
|
+
"properties": {
|
|
142
|
+
"name": {"type": "string", "description": "Custom directory name"},
|
|
143
|
+
"description": {
|
|
144
|
+
"type": ["string", "null"],
|
|
145
|
+
"description": "No description",
|
|
146
|
+
"x-documentation-alternatives": [
|
|
147
|
+
{"type": "null", "description": "No description"},
|
|
148
|
+
{"type": "string", "description": "Custom directory description"},
|
|
149
|
+
],
|
|
150
|
+
},
|
|
151
|
+
"settings": {
|
|
152
|
+
"type": "object",
|
|
153
|
+
"description": "Directory settings, for example multi_select or allow_editing.",
|
|
154
|
+
},
|
|
155
|
+
"fields": {
|
|
156
|
+
"type": "array",
|
|
157
|
+
"description": "Directory fields definition",
|
|
158
|
+
"items": {
|
|
159
|
+
"type": "object",
|
|
160
|
+
"properties": {
|
|
161
|
+
"name": {
|
|
162
|
+
"type": "string",
|
|
163
|
+
"minLength": 1,
|
|
164
|
+
"maxLength": 256,
|
|
165
|
+
"description": "Field name",
|
|
166
|
+
},
|
|
167
|
+
"type": {
|
|
168
|
+
"enum": [
|
|
169
|
+
"string",
|
|
170
|
+
"number",
|
|
171
|
+
"date",
|
|
172
|
+
"email",
|
|
173
|
+
"url",
|
|
174
|
+
"phone",
|
|
175
|
+
"checkbox",
|
|
176
|
+
"select",
|
|
177
|
+
"user",
|
|
178
|
+
"catalog",
|
|
179
|
+
"directory_link",
|
|
180
|
+
"file",
|
|
181
|
+
],
|
|
182
|
+
"description": "Field type",
|
|
183
|
+
"type": "string",
|
|
184
|
+
},
|
|
185
|
+
"required": {
|
|
186
|
+
"type": "boolean",
|
|
187
|
+
"default": False,
|
|
188
|
+
"description": "Required field flag",
|
|
189
|
+
},
|
|
190
|
+
"sort_order": {
|
|
191
|
+
"type": "integer",
|
|
192
|
+
"minimum": 0,
|
|
193
|
+
"description": "Field position",
|
|
194
|
+
},
|
|
195
|
+
"custom_property_uid": {
|
|
196
|
+
"description": "Empty custom property reference",
|
|
197
|
+
"format": "uuid",
|
|
198
|
+
"type": ["null", "string"],
|
|
199
|
+
"x-documentation-alternatives": [
|
|
200
|
+
{
|
|
201
|
+
"type": "null",
|
|
202
|
+
"description": "Empty custom property reference",
|
|
203
|
+
},
|
|
204
|
+
{
|
|
205
|
+
"type": "string",
|
|
206
|
+
"format": "uuid",
|
|
207
|
+
"description": "Custom property UID (required for select/user/catalog fields)",
|
|
208
|
+
},
|
|
209
|
+
],
|
|
210
|
+
},
|
|
211
|
+
"linked_directory_id": {
|
|
212
|
+
"description": "Empty linked directory reference",
|
|
213
|
+
"format": "uuid",
|
|
214
|
+
"type": ["null", "string"],
|
|
215
|
+
"x-documentation-alternatives": [
|
|
216
|
+
{
|
|
217
|
+
"type": "null",
|
|
218
|
+
"description": "Empty linked directory reference",
|
|
219
|
+
},
|
|
220
|
+
{
|
|
221
|
+
"type": "string",
|
|
222
|
+
"format": "uuid",
|
|
223
|
+
"description": "Linked custom directory ID (required for directory_link fields)",
|
|
224
|
+
},
|
|
225
|
+
],
|
|
226
|
+
},
|
|
227
|
+
},
|
|
228
|
+
"required": ["name", "type"],
|
|
229
|
+
},
|
|
230
|
+
},
|
|
231
|
+
"payload": {
|
|
232
|
+
"type": "object",
|
|
233
|
+
"description": "Extra JSON body fields from the Kaiten API docs. Merged into the request body.",
|
|
234
|
+
},
|
|
235
|
+
"multi_select": {
|
|
236
|
+
"type": "boolean",
|
|
237
|
+
"default": False,
|
|
238
|
+
"description": "When enabled, directory records can store multiple values per field",
|
|
239
|
+
},
|
|
240
|
+
"allow_editing": {
|
|
241
|
+
"type": "boolean",
|
|
242
|
+
"default": False,
|
|
243
|
+
"description": "When enabled, directory records can be edited from cards without custom properties permission",
|
|
244
|
+
},
|
|
245
|
+
"display_field_index": {
|
|
246
|
+
"type": "integer",
|
|
247
|
+
"minimum": 0,
|
|
248
|
+
"description": "Index of the field to use as a display field. If omitted, the first field is used.",
|
|
249
|
+
},
|
|
250
|
+
},
|
|
251
|
+
"required": ["name"],
|
|
252
|
+
},
|
|
253
|
+
operation=OperationSpec(
|
|
254
|
+
method="POST",
|
|
255
|
+
path_template="/company/custom-directories",
|
|
256
|
+
body_fields=(
|
|
257
|
+
"name",
|
|
258
|
+
"description",
|
|
259
|
+
"settings",
|
|
260
|
+
"fields",
|
|
261
|
+
"payload",
|
|
262
|
+
"multi_select",
|
|
263
|
+
"allow_editing",
|
|
264
|
+
"display_field_index",
|
|
265
|
+
),
|
|
266
|
+
),
|
|
267
|
+
runtime_behavior=RuntimeBehavior(request_shaper=payload_body_request),
|
|
268
|
+
examples=(
|
|
269
|
+
ExampleSpec(
|
|
270
|
+
command='kaiten --json custom-directories create --name "Contacts" --settings \'{"multi_select":false,"allow_editing":true}\'',
|
|
271
|
+
description="Create a Catalog.",
|
|
272
|
+
),
|
|
273
|
+
),
|
|
274
|
+
search_terms=(
|
|
275
|
+
"каталог",
|
|
276
|
+
"каталоги",
|
|
277
|
+
"справочник",
|
|
278
|
+
"справочник-таблица",
|
|
279
|
+
"справочник таблица",
|
|
280
|
+
"табличный справочник",
|
|
281
|
+
),
|
|
282
|
+
usage_notes=CATALOG_USAGE_NOTES,
|
|
283
|
+
),
|
|
284
|
+
make_tool(
|
|
285
|
+
canonical_name="custom-directories.update",
|
|
286
|
+
mcp_alias="kaiten_update_custom_directory",
|
|
287
|
+
description="Update a Kaiten Catalog (custom directory).",
|
|
288
|
+
input_schema={
|
|
289
|
+
"type": "object",
|
|
290
|
+
"properties": {
|
|
291
|
+
"directory_id": {"type": "string", "description": "Custom directory ID (UUID)."},
|
|
292
|
+
"name": {"type": "string", "description": "Custom directory name"},
|
|
293
|
+
"description": {
|
|
294
|
+
"type": ["string", "null"],
|
|
295
|
+
"description": "No description",
|
|
296
|
+
"x-documentation-alternatives": [
|
|
297
|
+
{"type": "null", "description": "No description"},
|
|
298
|
+
{"type": "string", "description": "Custom directory description"},
|
|
299
|
+
],
|
|
300
|
+
},
|
|
301
|
+
"settings": {"type": "object", "description": "Directory settings."},
|
|
302
|
+
"condition": {
|
|
303
|
+
"type": "string",
|
|
304
|
+
"enum": ["active", "inactive", "removed"],
|
|
305
|
+
"description": "Custom directory condition",
|
|
306
|
+
},
|
|
307
|
+
"payload": {
|
|
308
|
+
"type": "object",
|
|
309
|
+
"description": "Extra JSON body fields from the Kaiten API docs. Merged into the request body.",
|
|
310
|
+
},
|
|
311
|
+
"multi_select": {
|
|
312
|
+
"type": "boolean",
|
|
313
|
+
"description": "When enabled, directory records can store multiple values per field",
|
|
314
|
+
},
|
|
315
|
+
"allow_editing": {
|
|
316
|
+
"type": "boolean",
|
|
317
|
+
"description": "When enabled, directory records can be edited from cards without custom properties permission",
|
|
318
|
+
},
|
|
319
|
+
"fields": {
|
|
320
|
+
"type": "array",
|
|
321
|
+
"description": "Full fields list. Fields omitted from this array are soft-deleted (condition=removed).",
|
|
322
|
+
"items": {
|
|
323
|
+
"type": "object",
|
|
324
|
+
"properties": {
|
|
325
|
+
"id": {
|
|
326
|
+
"type": "string",
|
|
327
|
+
"format": "uuid",
|
|
328
|
+
"description": "Field ID (for updating an existing field)",
|
|
329
|
+
},
|
|
330
|
+
"name": {
|
|
331
|
+
"type": "string",
|
|
332
|
+
"minLength": 1,
|
|
333
|
+
"maxLength": 256,
|
|
334
|
+
"description": "Field name",
|
|
335
|
+
},
|
|
336
|
+
"type": {
|
|
337
|
+
"enum": [
|
|
338
|
+
"string",
|
|
339
|
+
"number",
|
|
340
|
+
"date",
|
|
341
|
+
"email",
|
|
342
|
+
"url",
|
|
343
|
+
"phone",
|
|
344
|
+
"checkbox",
|
|
345
|
+
"select",
|
|
346
|
+
"user",
|
|
347
|
+
"catalog",
|
|
348
|
+
"directory_link",
|
|
349
|
+
"file",
|
|
350
|
+
],
|
|
351
|
+
"description": "Field type",
|
|
352
|
+
"type": "string",
|
|
353
|
+
},
|
|
354
|
+
"required": {"type": "boolean", "description": "Required field flag"},
|
|
355
|
+
"is_display": {
|
|
356
|
+
"type": "boolean",
|
|
357
|
+
"description": "Display field flag (only one field should have is_display=true)",
|
|
358
|
+
},
|
|
359
|
+
"sort_order": {
|
|
360
|
+
"type": "integer",
|
|
361
|
+
"minimum": 0,
|
|
362
|
+
"description": "Field position",
|
|
363
|
+
},
|
|
364
|
+
"custom_property_uid": {
|
|
365
|
+
"description": "Empty custom property reference",
|
|
366
|
+
"format": "uuid",
|
|
367
|
+
"type": ["null", "string"],
|
|
368
|
+
"x-documentation-alternatives": [
|
|
369
|
+
{
|
|
370
|
+
"type": "null",
|
|
371
|
+
"description": "Empty custom property reference",
|
|
372
|
+
},
|
|
373
|
+
{
|
|
374
|
+
"type": "string",
|
|
375
|
+
"format": "uuid",
|
|
376
|
+
"description": "Custom property UID (required for select/user/catalog fields)",
|
|
377
|
+
},
|
|
378
|
+
],
|
|
379
|
+
},
|
|
380
|
+
"linked_directory_id": {
|
|
381
|
+
"description": "Empty linked directory reference",
|
|
382
|
+
"format": "uuid",
|
|
383
|
+
"type": ["null", "string"],
|
|
384
|
+
"x-documentation-alternatives": [
|
|
385
|
+
{
|
|
386
|
+
"type": "null",
|
|
387
|
+
"description": "Empty linked directory reference",
|
|
388
|
+
},
|
|
389
|
+
{
|
|
390
|
+
"type": "string",
|
|
391
|
+
"format": "uuid",
|
|
392
|
+
"description": "Linked custom directory ID (required for directory_link fields)",
|
|
393
|
+
},
|
|
394
|
+
],
|
|
395
|
+
},
|
|
396
|
+
},
|
|
397
|
+
},
|
|
398
|
+
},
|
|
399
|
+
},
|
|
400
|
+
"required": ["directory_id"],
|
|
401
|
+
},
|
|
402
|
+
operation=OperationSpec(
|
|
403
|
+
method="PATCH",
|
|
404
|
+
path_template="/company/custom-directories/{directory_id}",
|
|
405
|
+
path_fields=("directory_id",),
|
|
406
|
+
body_fields=(
|
|
407
|
+
"name",
|
|
408
|
+
"description",
|
|
409
|
+
"settings",
|
|
410
|
+
"condition",
|
|
411
|
+
"payload",
|
|
412
|
+
"multi_select",
|
|
413
|
+
"allow_editing",
|
|
414
|
+
"fields",
|
|
415
|
+
),
|
|
416
|
+
),
|
|
417
|
+
runtime_behavior=RuntimeBehavior(request_shaper=payload_body_request),
|
|
418
|
+
examples=(
|
|
419
|
+
ExampleSpec(
|
|
420
|
+
command='kaiten --json custom-directories update --directory-id dir-uuid --name "Clients"',
|
|
421
|
+
description="Update a Catalog.",
|
|
422
|
+
),
|
|
423
|
+
),
|
|
424
|
+
search_terms=(
|
|
425
|
+
"каталог",
|
|
426
|
+
"каталоги",
|
|
427
|
+
"справочник",
|
|
428
|
+
"справочник-таблица",
|
|
429
|
+
"справочник таблица",
|
|
430
|
+
"табличный справочник",
|
|
431
|
+
),
|
|
432
|
+
usage_notes=CATALOG_USAGE_NOTES,
|
|
433
|
+
),
|
|
434
|
+
make_tool(
|
|
435
|
+
canonical_name="custom-directories.delete",
|
|
436
|
+
mcp_alias="kaiten_delete_custom_directory",
|
|
437
|
+
description="Delete a Kaiten Catalog (custom directory).",
|
|
438
|
+
input_schema={
|
|
439
|
+
"type": "object",
|
|
440
|
+
"properties": {"directory_id": DIRECTORY_ID},
|
|
441
|
+
"required": ["directory_id"],
|
|
442
|
+
},
|
|
443
|
+
operation=OperationSpec(
|
|
444
|
+
method="DELETE",
|
|
445
|
+
path_template="/company/custom-directories/{directory_id}",
|
|
446
|
+
path_fields=("directory_id",),
|
|
447
|
+
),
|
|
448
|
+
examples=(
|
|
449
|
+
ExampleSpec(
|
|
450
|
+
command="kaiten --json custom-directories delete --directory-id dir-uuid",
|
|
451
|
+
description="Delete a Catalog.",
|
|
452
|
+
),
|
|
453
|
+
),
|
|
454
|
+
search_terms=(
|
|
455
|
+
"каталог",
|
|
456
|
+
"каталоги",
|
|
457
|
+
"справочник",
|
|
458
|
+
"справочник-таблица",
|
|
459
|
+
"справочник таблица",
|
|
460
|
+
"табличный справочник",
|
|
461
|
+
),
|
|
462
|
+
usage_notes=CATALOG_USAGE_NOTES,
|
|
463
|
+
),
|
|
464
|
+
make_tool(
|
|
465
|
+
canonical_name="custom-directory-fields.list",
|
|
466
|
+
mcp_alias="kaiten_list_custom_directory_fields",
|
|
467
|
+
description="List fields (columns) of a Kaiten Catalog.",
|
|
468
|
+
input_schema={
|
|
469
|
+
"type": "object",
|
|
470
|
+
"properties": {
|
|
471
|
+
"directory_id": {"type": "string", "description": "Custom directory ID (UUID)."},
|
|
472
|
+
"include_author": {"type": "boolean", "description": "Include author user object"},
|
|
473
|
+
"conditions": {
|
|
474
|
+
"type": "array",
|
|
475
|
+
"description": "Filter by condition values: active | inactive | removed",
|
|
476
|
+
"items": {"type": "string"},
|
|
477
|
+
},
|
|
478
|
+
},
|
|
479
|
+
"required": ["directory_id"],
|
|
480
|
+
},
|
|
481
|
+
operation=OperationSpec(
|
|
482
|
+
method="GET",
|
|
483
|
+
path_template="/company/custom-directories/{directory_id}/fields",
|
|
484
|
+
path_fields=("directory_id",),
|
|
485
|
+
query_fields=("include_author", "conditions"),
|
|
486
|
+
),
|
|
487
|
+
response_policy=ResponsePolicy(result_kind="list"),
|
|
488
|
+
examples=(
|
|
489
|
+
ExampleSpec(
|
|
490
|
+
command="kaiten --json custom-directory-fields list --directory-id dir-uuid",
|
|
491
|
+
description="List Catalog fields.",
|
|
492
|
+
),
|
|
493
|
+
),
|
|
494
|
+
search_terms=(
|
|
495
|
+
"каталог",
|
|
496
|
+
"каталоги",
|
|
497
|
+
"справочник",
|
|
498
|
+
"справочник-таблица",
|
|
499
|
+
"справочник таблица",
|
|
500
|
+
"табличный справочник",
|
|
501
|
+
),
|
|
502
|
+
usage_notes=CATALOG_USAGE_NOTES,
|
|
503
|
+
),
|
|
504
|
+
make_tool(
|
|
505
|
+
canonical_name="custom-directory-fields.get",
|
|
506
|
+
mcp_alias="kaiten_get_custom_directory_field",
|
|
507
|
+
description="Get a field (column) of a Kaiten Catalog.",
|
|
508
|
+
input_schema={
|
|
509
|
+
"type": "object",
|
|
510
|
+
"properties": {"directory_id": DIRECTORY_ID, "field_id": FIELD_ID},
|
|
511
|
+
"required": ["directory_id", "field_id"],
|
|
512
|
+
},
|
|
513
|
+
operation=OperationSpec(
|
|
514
|
+
method="GET",
|
|
515
|
+
path_template="/company/custom-directories/{directory_id}/fields/{field_id}",
|
|
516
|
+
path_fields=("directory_id", "field_id"),
|
|
517
|
+
),
|
|
518
|
+
examples=(
|
|
519
|
+
ExampleSpec(
|
|
520
|
+
command="kaiten --json custom-directory-fields get --directory-id dir-uuid --field-id field-uuid",
|
|
521
|
+
description="Get a Catalog field.",
|
|
522
|
+
),
|
|
523
|
+
),
|
|
524
|
+
search_terms=(
|
|
525
|
+
"каталог",
|
|
526
|
+
"каталоги",
|
|
527
|
+
"справочник",
|
|
528
|
+
"справочник-таблица",
|
|
529
|
+
"справочник таблица",
|
|
530
|
+
"табличный справочник",
|
|
531
|
+
),
|
|
532
|
+
usage_notes=CATALOG_USAGE_NOTES,
|
|
533
|
+
),
|
|
534
|
+
make_tool(
|
|
535
|
+
canonical_name="custom-directory-fields.create",
|
|
536
|
+
mcp_alias="kaiten_create_custom_directory_field",
|
|
537
|
+
description="Create a field (column) in a Kaiten Catalog.",
|
|
538
|
+
input_schema={
|
|
539
|
+
"type": "object",
|
|
540
|
+
"properties": {
|
|
541
|
+
"directory_id": {"type": "string", "description": "Custom directory ID (UUID)."},
|
|
542
|
+
"name": {"type": "string", "description": "Field name"},
|
|
543
|
+
"type": {
|
|
544
|
+
"type": "string",
|
|
545
|
+
"description": "Field type, for example string, email, phone, or catalog.",
|
|
546
|
+
},
|
|
547
|
+
"required": {
|
|
548
|
+
"type": "boolean",
|
|
549
|
+
"description": "Required field flag",
|
|
550
|
+
"default": False,
|
|
551
|
+
},
|
|
552
|
+
"is_display": {
|
|
553
|
+
"type": "boolean",
|
|
554
|
+
"description": "Display field flag",
|
|
555
|
+
"default": False,
|
|
556
|
+
},
|
|
557
|
+
"sort_order": {"type": ["number", "integer"], "description": "Field position"},
|
|
558
|
+
"settings": {"type": "object", "description": "Type-specific field settings."},
|
|
559
|
+
"payload": {
|
|
560
|
+
"type": "object",
|
|
561
|
+
"description": "Extra JSON body fields from the Kaiten API docs. Merged into the request body.",
|
|
562
|
+
},
|
|
563
|
+
},
|
|
564
|
+
"required": ["directory_id", "name", "type"],
|
|
565
|
+
},
|
|
566
|
+
operation=OperationSpec(
|
|
567
|
+
method="POST",
|
|
568
|
+
path_template="/company/custom-directories/{directory_id}/fields",
|
|
569
|
+
path_fields=("directory_id",),
|
|
570
|
+
body_fields=(
|
|
571
|
+
"name",
|
|
572
|
+
"type",
|
|
573
|
+
"required",
|
|
574
|
+
"is_display",
|
|
575
|
+
"sort_order",
|
|
576
|
+
"settings",
|
|
577
|
+
"payload",
|
|
578
|
+
),
|
|
579
|
+
),
|
|
580
|
+
runtime_behavior=RuntimeBehavior(request_shaper=payload_body_request),
|
|
581
|
+
examples=(
|
|
582
|
+
ExampleSpec(
|
|
583
|
+
command="kaiten --json custom-directory-fields create --directory-id dir-uuid --name Email --type email",
|
|
584
|
+
description="Create a Catalog field.",
|
|
585
|
+
),
|
|
586
|
+
),
|
|
587
|
+
search_terms=(
|
|
588
|
+
"каталог",
|
|
589
|
+
"каталоги",
|
|
590
|
+
"справочник",
|
|
591
|
+
"справочник-таблица",
|
|
592
|
+
"справочник таблица",
|
|
593
|
+
"табличный справочник",
|
|
594
|
+
),
|
|
595
|
+
usage_notes=CATALOG_USAGE_NOTES,
|
|
596
|
+
),
|
|
597
|
+
make_tool(
|
|
598
|
+
canonical_name="custom-directory-fields.update",
|
|
599
|
+
mcp_alias="kaiten_update_custom_directory_field",
|
|
600
|
+
description="Update a field (column) in a Kaiten Catalog.",
|
|
601
|
+
input_schema={
|
|
602
|
+
"type": "object",
|
|
603
|
+
"properties": {
|
|
604
|
+
"directory_id": {"type": "string", "description": "Custom directory ID (UUID)."},
|
|
605
|
+
"field_id": {"type": "string", "description": "Custom directory field ID (UUID)."},
|
|
606
|
+
"name": {"type": "string", "description": "Field name"},
|
|
607
|
+
"required": {"type": "boolean", "description": "Required field flag"},
|
|
608
|
+
"is_display": {"type": "boolean", "description": "Display field flag"},
|
|
609
|
+
"sort_order": {"type": ["number", "integer"], "description": "Field position"},
|
|
610
|
+
"condition": {
|
|
611
|
+
"type": "string",
|
|
612
|
+
"enum": ["active", "inactive", "removed"],
|
|
613
|
+
"description": "Custom directory field condition",
|
|
614
|
+
},
|
|
615
|
+
"settings": {"type": "object", "description": "Type-specific field settings."},
|
|
616
|
+
"payload": {
|
|
617
|
+
"type": "object",
|
|
618
|
+
"description": "Extra JSON body fields from the Kaiten API docs. Merged into the request body.",
|
|
619
|
+
},
|
|
620
|
+
},
|
|
621
|
+
"required": ["directory_id", "field_id"],
|
|
622
|
+
},
|
|
623
|
+
operation=OperationSpec(
|
|
624
|
+
method="PATCH",
|
|
625
|
+
path_template="/company/custom-directories/{directory_id}/fields/{field_id}",
|
|
626
|
+
path_fields=("directory_id", "field_id"),
|
|
627
|
+
body_fields=(
|
|
628
|
+
"name",
|
|
629
|
+
"required",
|
|
630
|
+
"is_display",
|
|
631
|
+
"sort_order",
|
|
632
|
+
"condition",
|
|
633
|
+
"settings",
|
|
634
|
+
"payload",
|
|
635
|
+
),
|
|
636
|
+
),
|
|
637
|
+
runtime_behavior=RuntimeBehavior(request_shaper=payload_body_request),
|
|
638
|
+
examples=(
|
|
639
|
+
ExampleSpec(
|
|
640
|
+
command="kaiten --json custom-directory-fields update --directory-id dir-uuid --field-id field-uuid --required",
|
|
641
|
+
description="Update a Catalog field.",
|
|
642
|
+
),
|
|
643
|
+
),
|
|
644
|
+
search_terms=(
|
|
645
|
+
"каталог",
|
|
646
|
+
"каталоги",
|
|
647
|
+
"справочник",
|
|
648
|
+
"справочник-таблица",
|
|
649
|
+
"справочник таблица",
|
|
650
|
+
"табличный справочник",
|
|
651
|
+
),
|
|
652
|
+
usage_notes=CATALOG_USAGE_NOTES,
|
|
653
|
+
),
|
|
654
|
+
make_tool(
|
|
655
|
+
canonical_name="custom-directory-fields.delete",
|
|
656
|
+
mcp_alias="kaiten_delete_custom_directory_field",
|
|
657
|
+
description="Delete a field (column) from a Kaiten Catalog.",
|
|
658
|
+
input_schema={
|
|
659
|
+
"type": "object",
|
|
660
|
+
"properties": {"directory_id": DIRECTORY_ID, "field_id": FIELD_ID},
|
|
661
|
+
"required": ["directory_id", "field_id"],
|
|
662
|
+
},
|
|
663
|
+
operation=OperationSpec(
|
|
664
|
+
method="DELETE",
|
|
665
|
+
path_template="/company/custom-directories/{directory_id}/fields/{field_id}",
|
|
666
|
+
path_fields=("directory_id", "field_id"),
|
|
667
|
+
),
|
|
668
|
+
examples=(
|
|
669
|
+
ExampleSpec(
|
|
670
|
+
command="kaiten --json custom-directory-fields delete --directory-id dir-uuid --field-id field-uuid",
|
|
671
|
+
description="Delete a Catalog field.",
|
|
672
|
+
),
|
|
673
|
+
),
|
|
674
|
+
search_terms=(
|
|
675
|
+
"каталог",
|
|
676
|
+
"каталоги",
|
|
677
|
+
"справочник",
|
|
678
|
+
"справочник-таблица",
|
|
679
|
+
"справочник таблица",
|
|
680
|
+
"табличный справочник",
|
|
681
|
+
),
|
|
682
|
+
usage_notes=CATALOG_USAGE_NOTES,
|
|
683
|
+
),
|
|
684
|
+
make_tool(
|
|
685
|
+
canonical_name="custom-directory-records.list",
|
|
686
|
+
mcp_alias="kaiten_list_custom_directory_records",
|
|
687
|
+
description="List records (rows) of a Kaiten Catalog.",
|
|
688
|
+
input_schema={
|
|
689
|
+
"type": "object",
|
|
690
|
+
"properties": {
|
|
691
|
+
"directory_id": {"type": "string", "description": "Custom directory ID (UUID)."},
|
|
692
|
+
"query": {"type": "string", "description": "Quick search by record display value"},
|
|
693
|
+
"profile": {
|
|
694
|
+
"type": "string",
|
|
695
|
+
"enum": ["none", "summary", "details", "full"],
|
|
696
|
+
"description": "Controls included relations in response",
|
|
697
|
+
"x-documentation-constraints": "none | summary | details | full",
|
|
698
|
+
},
|
|
699
|
+
"include_values": {
|
|
700
|
+
"type": "boolean",
|
|
701
|
+
"description": "Legacy: include values array",
|
|
702
|
+
},
|
|
703
|
+
"include_author": {"type": "boolean", "description": "Include author user object"},
|
|
704
|
+
"conditions": {
|
|
705
|
+
"type": "array",
|
|
706
|
+
"description": "Filter by condition values: active | inactive | removed",
|
|
707
|
+
"items": {"type": "string"},
|
|
708
|
+
},
|
|
709
|
+
"filters": {"type": "object", "description": "Advanced field-based filters (JSON)"},
|
|
710
|
+
"filter_operator": {
|
|
711
|
+
"type": "string",
|
|
712
|
+
"enum": ["and", "or"],
|
|
713
|
+
"description": "Boolean operator for filters (default: and)",
|
|
714
|
+
"x-documentation-constraints": "and | or",
|
|
715
|
+
},
|
|
716
|
+
"limit": {
|
|
717
|
+
"type": "integer",
|
|
718
|
+
"description": "Max results, capped by Kaiten at 100.",
|
|
719
|
+
},
|
|
720
|
+
"offset": {"type": "integer", "description": "Pagination offset."},
|
|
721
|
+
},
|
|
722
|
+
"required": ["directory_id"],
|
|
723
|
+
},
|
|
724
|
+
operation=OperationSpec(
|
|
725
|
+
method="GET",
|
|
726
|
+
path_template="/company/custom-directories/{directory_id}/records",
|
|
727
|
+
path_fields=("directory_id",),
|
|
728
|
+
query_fields=(
|
|
729
|
+
"query",
|
|
730
|
+
"profile",
|
|
731
|
+
"include_values",
|
|
732
|
+
"include_author",
|
|
733
|
+
"conditions",
|
|
734
|
+
"filters",
|
|
735
|
+
"filter_operator",
|
|
736
|
+
"limit",
|
|
737
|
+
"offset",
|
|
738
|
+
),
|
|
739
|
+
),
|
|
740
|
+
response_policy=ResponsePolicy(default_limit=100, result_kind="list"),
|
|
741
|
+
runtime_behavior=RuntimeBehavior(request_shaper=encode_object_query_request),
|
|
742
|
+
examples=(
|
|
743
|
+
ExampleSpec(
|
|
744
|
+
command="kaiten --json custom-directory-records list --directory-id dir-uuid --profile summary",
|
|
745
|
+
description="List Catalog records.",
|
|
746
|
+
),
|
|
747
|
+
),
|
|
748
|
+
search_terms=(
|
|
749
|
+
"каталог",
|
|
750
|
+
"каталоги",
|
|
751
|
+
"справочник",
|
|
752
|
+
"справочник-таблица",
|
|
753
|
+
"справочник таблица",
|
|
754
|
+
"табличный справочник",
|
|
755
|
+
),
|
|
756
|
+
usage_notes=CATALOG_USAGE_NOTES,
|
|
757
|
+
),
|
|
758
|
+
make_tool(
|
|
759
|
+
canonical_name="custom-directory-records.get",
|
|
760
|
+
mcp_alias="kaiten_get_custom_directory_record",
|
|
761
|
+
description="Get a record (row) from a Kaiten Catalog.",
|
|
762
|
+
input_schema={
|
|
763
|
+
"type": "object",
|
|
764
|
+
"properties": {
|
|
765
|
+
"directory_id": {"type": "string", "description": "Custom directory ID (UUID)."},
|
|
766
|
+
"record_id": {
|
|
767
|
+
"type": "string",
|
|
768
|
+
"description": "Custom directory record ID (UUID).",
|
|
769
|
+
},
|
|
770
|
+
"profile": {
|
|
771
|
+
"type": "string",
|
|
772
|
+
"enum": ["none", "summary", "details", "full"],
|
|
773
|
+
"description": "Controls included relations in response",
|
|
774
|
+
"x-documentation-constraints": "none | summary | details | full",
|
|
775
|
+
},
|
|
776
|
+
},
|
|
777
|
+
"required": ["directory_id", "record_id"],
|
|
778
|
+
},
|
|
779
|
+
operation=OperationSpec(
|
|
780
|
+
method="GET",
|
|
781
|
+
path_template="/company/custom-directories/{directory_id}/records/{record_id}",
|
|
782
|
+
path_fields=("directory_id", "record_id"),
|
|
783
|
+
query_fields=("profile",),
|
|
784
|
+
),
|
|
785
|
+
examples=(
|
|
786
|
+
ExampleSpec(
|
|
787
|
+
command="kaiten --json custom-directory-records get --directory-id dir-uuid --record-id record-uuid",
|
|
788
|
+
description="Get a Catalog record.",
|
|
789
|
+
),
|
|
790
|
+
),
|
|
791
|
+
search_terms=(
|
|
792
|
+
"каталог",
|
|
793
|
+
"каталоги",
|
|
794
|
+
"справочник",
|
|
795
|
+
"справочник-таблица",
|
|
796
|
+
"справочник таблица",
|
|
797
|
+
"табличный справочник",
|
|
798
|
+
),
|
|
799
|
+
usage_notes=CATALOG_USAGE_NOTES,
|
|
800
|
+
),
|
|
801
|
+
make_tool(
|
|
802
|
+
canonical_name="custom-directory-records.create",
|
|
803
|
+
mcp_alias="kaiten_create_custom_directory_record",
|
|
804
|
+
description="Create a record (row) in a Kaiten Catalog.",
|
|
805
|
+
input_schema={
|
|
806
|
+
"type": "object",
|
|
807
|
+
"properties": {
|
|
808
|
+
"directory_id": {"type": "string", "description": "Custom directory ID (UUID)."},
|
|
809
|
+
"values": {
|
|
810
|
+
"type": ["object", "array"],
|
|
811
|
+
"description": "Values map where keys are custom directory field IDs. Each value is either an object (single-value) or an array of objects (multi-select).",
|
|
812
|
+
},
|
|
813
|
+
"payload": {
|
|
814
|
+
"type": "object",
|
|
815
|
+
"description": "Extra JSON body fields from the Kaiten API docs. Merged into the request body.",
|
|
816
|
+
},
|
|
817
|
+
"response_profile": {
|
|
818
|
+
"type": "string",
|
|
819
|
+
"description": "Controls response size. Use `none` to return `{ id }` only.",
|
|
820
|
+
"x-documentation-constraints": "none | summary | details | full",
|
|
821
|
+
},
|
|
822
|
+
},
|
|
823
|
+
"required": ["directory_id", "values"],
|
|
824
|
+
},
|
|
825
|
+
operation=OperationSpec(
|
|
826
|
+
method="POST",
|
|
827
|
+
path_template="/company/custom-directories/{directory_id}/records",
|
|
828
|
+
path_fields=("directory_id",),
|
|
829
|
+
body_fields=("values", "payload"),
|
|
830
|
+
query_fields=("response_profile",),
|
|
831
|
+
),
|
|
832
|
+
runtime_behavior=RuntimeBehavior(request_shaper=payload_body_request),
|
|
833
|
+
examples=(
|
|
834
|
+
ExampleSpec(
|
|
835
|
+
command='kaiten --json custom-directory-records create --directory-id dir-uuid --values \'{"field-uuid":"Alice"}\'',
|
|
836
|
+
description="Create a Catalog record.",
|
|
837
|
+
),
|
|
838
|
+
),
|
|
839
|
+
search_terms=(
|
|
840
|
+
"каталог",
|
|
841
|
+
"каталоги",
|
|
842
|
+
"справочник",
|
|
843
|
+
"справочник-таблица",
|
|
844
|
+
"справочник таблица",
|
|
845
|
+
"табличный справочник",
|
|
846
|
+
),
|
|
847
|
+
usage_notes=CATALOG_USAGE_NOTES,
|
|
848
|
+
),
|
|
849
|
+
make_tool(
|
|
850
|
+
canonical_name="custom-directory-records.update",
|
|
851
|
+
mcp_alias="kaiten_update_custom_directory_record",
|
|
852
|
+
description="Update a record (row) in a Kaiten Catalog.",
|
|
853
|
+
input_schema={
|
|
854
|
+
"type": "object",
|
|
855
|
+
"properties": {
|
|
856
|
+
"directory_id": {"type": "string", "description": "Custom directory ID (UUID)."},
|
|
857
|
+
"record_id": {
|
|
858
|
+
"type": "string",
|
|
859
|
+
"description": "Custom directory record ID (UUID).",
|
|
860
|
+
},
|
|
861
|
+
"values": {
|
|
862
|
+
"type": ["object", "array"],
|
|
863
|
+
"description": "Values map where keys are custom directory field IDs. Each value is either an object (single-value) or an array of objects (multi-select).",
|
|
864
|
+
},
|
|
865
|
+
"condition": {
|
|
866
|
+
"type": "string",
|
|
867
|
+
"enum": ["active", "inactive", "removed"],
|
|
868
|
+
"description": "Custom directory record condition",
|
|
869
|
+
},
|
|
870
|
+
"payload": {
|
|
871
|
+
"type": "object",
|
|
872
|
+
"description": "Extra JSON body fields from the Kaiten API docs. Merged into the request body.",
|
|
873
|
+
},
|
|
874
|
+
"response_profile": {
|
|
875
|
+
"type": "string",
|
|
876
|
+
"description": "Controls response size. Use `none` to return `{ id }` only.",
|
|
877
|
+
"x-documentation-constraints": "none | summary | details | full",
|
|
878
|
+
},
|
|
879
|
+
},
|
|
880
|
+
"required": ["directory_id", "record_id"],
|
|
881
|
+
},
|
|
882
|
+
operation=OperationSpec(
|
|
883
|
+
method="PATCH",
|
|
884
|
+
path_template="/company/custom-directories/{directory_id}/records/{record_id}",
|
|
885
|
+
path_fields=("directory_id", "record_id"),
|
|
886
|
+
body_fields=("values", "condition", "payload"),
|
|
887
|
+
query_fields=("response_profile",),
|
|
888
|
+
),
|
|
889
|
+
runtime_behavior=RuntimeBehavior(request_shaper=payload_body_request),
|
|
890
|
+
examples=(
|
|
891
|
+
ExampleSpec(
|
|
892
|
+
command='kaiten --json custom-directory-records update --directory-id dir-uuid --record-id record-uuid --values \'{"field-uuid":"Bob"}\'',
|
|
893
|
+
description="Update a Catalog record.",
|
|
894
|
+
),
|
|
895
|
+
),
|
|
896
|
+
search_terms=(
|
|
897
|
+
"каталог",
|
|
898
|
+
"каталоги",
|
|
899
|
+
"справочник",
|
|
900
|
+
"справочник-таблица",
|
|
901
|
+
"справочник таблица",
|
|
902
|
+
"табличный справочник",
|
|
903
|
+
),
|
|
904
|
+
usage_notes=CATALOG_USAGE_NOTES,
|
|
905
|
+
),
|
|
906
|
+
make_tool(
|
|
907
|
+
canonical_name="custom-directory-records.delete",
|
|
908
|
+
mcp_alias="kaiten_delete_custom_directory_record",
|
|
909
|
+
description="Delete a record (row) from a Kaiten Catalog.",
|
|
910
|
+
input_schema={
|
|
911
|
+
"type": "object",
|
|
912
|
+
"properties": {"directory_id": DIRECTORY_ID, "record_id": RECORD_ID},
|
|
913
|
+
"required": ["directory_id", "record_id"],
|
|
914
|
+
},
|
|
915
|
+
operation=OperationSpec(
|
|
916
|
+
method="DELETE",
|
|
917
|
+
path_template="/company/custom-directories/{directory_id}/records/{record_id}",
|
|
918
|
+
path_fields=("directory_id", "record_id"),
|
|
919
|
+
),
|
|
920
|
+
examples=(
|
|
921
|
+
ExampleSpec(
|
|
922
|
+
command="kaiten --json custom-directory-records delete --directory-id dir-uuid --record-id record-uuid",
|
|
923
|
+
description="Delete a Catalog record.",
|
|
924
|
+
),
|
|
925
|
+
),
|
|
926
|
+
search_terms=(
|
|
927
|
+
"каталог",
|
|
928
|
+
"каталоги",
|
|
929
|
+
"справочник",
|
|
930
|
+
"справочник-таблица",
|
|
931
|
+
"справочник таблица",
|
|
932
|
+
"табличный справочник",
|
|
933
|
+
),
|
|
934
|
+
usage_notes=CATALOG_USAGE_NOTES,
|
|
935
|
+
),
|
|
936
|
+
make_tool(
|
|
937
|
+
canonical_name="custom-directory-records.cards.list",
|
|
938
|
+
mcp_alias="kaiten_list_custom_directory_record_cards",
|
|
939
|
+
description="List cards linked to a Kaiten Catalog record.",
|
|
940
|
+
input_schema={
|
|
941
|
+
"type": "object",
|
|
942
|
+
"properties": {
|
|
943
|
+
"directory_id": {"type": "string", "description": "Custom directory ID (UUID)."},
|
|
944
|
+
"record_id": {
|
|
945
|
+
"type": "string",
|
|
946
|
+
"description": "Custom directory record ID (UUID).",
|
|
947
|
+
},
|
|
948
|
+
"filter": {"type": "string", "description": "Base64-encoded JSON card filter"},
|
|
949
|
+
"limit": {
|
|
950
|
+
"type": "integer",
|
|
951
|
+
"description": "Max results, capped by Kaiten at 100.",
|
|
952
|
+
},
|
|
953
|
+
"offset": {"type": "integer", "description": "Pagination offset."},
|
|
954
|
+
},
|
|
955
|
+
"required": ["directory_id", "record_id"],
|
|
956
|
+
},
|
|
957
|
+
operation=OperationSpec(
|
|
958
|
+
method="GET",
|
|
959
|
+
path_template="/company/custom-directories/{directory_id}/records/{record_id}/cards",
|
|
960
|
+
path_fields=("directory_id", "record_id"),
|
|
961
|
+
query_fields=("filter", "limit", "offset"),
|
|
962
|
+
),
|
|
963
|
+
response_policy=ResponsePolicy(default_limit=100, result_kind="list"),
|
|
964
|
+
examples=(
|
|
965
|
+
ExampleSpec(
|
|
966
|
+
command="kaiten --json custom-directory-records cards list --directory-id dir-uuid --record-id record-uuid",
|
|
967
|
+
description="List cards linked to a Catalog record.",
|
|
968
|
+
),
|
|
969
|
+
),
|
|
970
|
+
search_terms=(
|
|
971
|
+
"каталог",
|
|
972
|
+
"каталоги",
|
|
973
|
+
"справочник",
|
|
974
|
+
"справочник-таблица",
|
|
975
|
+
"справочник таблица",
|
|
976
|
+
"табличный справочник",
|
|
977
|
+
),
|
|
978
|
+
usage_notes=CATALOG_USAGE_NOTES,
|
|
979
|
+
),
|
|
980
|
+
)
|