@cplace/mcp-server 1.5.2 → 1.6.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/README.md +44 -0
- package/dist/conditional-registration.d.ts.map +1 -1
- package/dist/conditional-registration.js +10 -0
- package/dist/conditional-registration.js.map +1 -1
- package/dist/profiles.d.ts.map +1 -1
- package/dist/profiles.js +7 -3
- package/dist/profiles.js.map +1 -1
- package/dist/tool-metadata.d.ts.map +1 -1
- package/dist/tool-metadata.js +8 -0
- package/dist/tool-metadata.js.map +1 -1
- package/dist/tools/board-widget.d.ts +140 -89
- package/dist/tools/board-widget.d.ts.map +1 -1
- package/dist/tools/board-widget.js +131 -112
- package/dist/tools/board-widget.js.map +1 -1
- package/dist/tools/documents.d.ts +18 -0
- package/dist/tools/documents.d.ts.map +1 -0
- package/dist/tools/documents.js +59 -0
- package/dist/tools/documents.js.map +1 -0
- package/dist/tools/expert-settings.d.ts +38 -0
- package/dist/tools/expert-settings.d.ts.map +1 -0
- package/dist/tools/expert-settings.js +145 -0
- package/dist/tools/expert-settings.js.map +1 -0
- package/dist/tools/job-schedule-trigger.d.ts +16 -0
- package/dist/tools/job-schedule-trigger.d.ts.map +1 -0
- package/dist/tools/job-schedule-trigger.js +32 -0
- package/dist/tools/job-schedule-trigger.js.map +1 -0
- package/dist/tools/job-scripts.d.ts +58 -0
- package/dist/tools/job-scripts.d.ts.map +1 -0
- package/dist/tools/job-scripts.js +215 -0
- package/dist/tools/job-scripts.js.map +1 -0
- package/dist/tools/layout-richstring-widgets.d.ts.map +1 -1
- package/dist/tools/layout-richstring-widgets.js +1 -42
- package/dist/tools/layout-richstring-widgets.js.map +1 -1
- package/dist/tools/layout.d.ts.map +1 -1
- package/dist/tools/layout.js +2 -34
- package/dist/tools/layout.js.map +1 -1
- package/dist/tools/resource-planner-widget.d.ts +280 -0
- package/dist/tools/resource-planner-widget.d.ts.map +1 -0
- package/dist/tools/resource-planner-widget.js +539 -0
- package/dist/tools/resource-planner-widget.js.map +1 -0
- package/dist/tools/widget-tool-helpers.d.ts +7 -0
- package/dist/tools/widget-tool-helpers.d.ts.map +1 -0
- package/dist/tools/widget-tool-helpers.js +43 -0
- package/dist/tools/widget-tool-helpers.js.map +1 -0
- package/dist/widget-specifications/cf.cplace.cboard.main.board/_implementation.md +24 -0
- package/dist/widget-specifications/cf.cplace.resourceManagement.resourcePlannerDefinition/_implementation.md +42 -0
- package/dist/widget-specifications/cf.cplace.resourceManagement.resourcePlannerDefinition/actionSearch.md +10 -0
- package/dist/widget-specifications/cf.cplace.resourceManagement.resourcePlannerDefinition/attributesConfiguration.md +30 -0
- package/dist/widget-specifications/cf.cplace.resourceManagement.resourcePlannerDefinition/chartSearch.md +10 -0
- package/dist/widget-specifications/cf.cplace.resourceManagement.resourcePlannerDefinition/dateCalculation.md +8 -0
- package/dist/widget-specifications/cf.cplace.resourceManagement.resourcePlannerDefinition/defaultColumnsConfiguration.md +7 -0
- package/dist/widget-specifications/cf.cplace.resourceManagement.resourcePlannerDefinition/searchFirstGroup.md +8 -0
- package/dist/widget-specifications/cf.cplace.resourceManagement.resourcePlannerDefinition/searchNode.md +8 -0
- package/dist/widget-specifications/cf.cplace.resourceManagement.resourcePlannerDefinition/searchRootNode.md +10 -0
- package/dist/widget-specifications/cf.cplace.resourceManagement.resourcePlannerDefinition/searchSecondGroup.md +8 -0
- package/dist/widget-specifications/cf.cplace.resourceManagement.resourcePlannerDefinition/treeStructure.md +1 -0
- package/package.json +1 -1
|
@@ -35,3 +35,27 @@ This creates an empty board that can then be configured using the specialized to
|
|
|
35
35
|
**Cross-Reference Validation**: Column and swimlane tools validate that all `searchId` references exist in card configurations.
|
|
36
36
|
|
|
37
37
|
**searchId Linking**: The `searchId` connects card sources to column/swimlane mappings, enabling multi-type boards with different mappings per source.
|
|
38
|
+
|
|
39
|
+
## Attribute Type Constraints
|
|
40
|
+
|
|
41
|
+
Columns and swimlanes only support a subset of attribute types. Using an unsupported type will cause configuration to fail.
|
|
42
|
+
|
|
43
|
+
**Valid attribute types for columns and swimlanes:**
|
|
44
|
+
- Enumeration values (text/number)
|
|
45
|
+
- References
|
|
46
|
+
- Linked attributes of type "Link" or "Enumeration value"
|
|
47
|
+
- Date values
|
|
48
|
+
|
|
49
|
+
**NOT valid for columns/swimlanes** (but valid for card display attributes):
|
|
50
|
+
- Workflow attributes (despite looking similar to enumerations, they are excluded)
|
|
51
|
+
- Number attributes
|
|
52
|
+
- Boolean attributes
|
|
53
|
+
- Color attributes
|
|
54
|
+
|
|
55
|
+
Card display is configured via `cardDisplay` in card configuration. Available display fields:
|
|
56
|
+
- `dateAttribute`: Date shown in card footer
|
|
57
|
+
- `tagAttributes`: Colored tag badges (array of attribute names)
|
|
58
|
+
- `colorAttribute`: Dynamic left-border color (requires `attribute` name and `colorMapping` of enum values to hex colors)
|
|
59
|
+
- `iconAttributes`: Icon indicators (array of `{attribute, enabled}` objects)
|
|
60
|
+
|
|
61
|
+
Columns and swimlanes are restricted to the attribute types listed above.
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
## Specialized Configuration Tools
|
|
2
|
+
|
|
3
|
+
Use these dedicated tools for resource planner widget configuration:
|
|
4
|
+
|
|
5
|
+
| Tool | Purpose |
|
|
6
|
+
|------|---------|
|
|
7
|
+
| `cplace_resource_planner_get_configuration` | Get current config in friendly grouped format |
|
|
8
|
+
| `cplace_resource_planner_configure_data_source` | Configure node search and date calculation |
|
|
9
|
+
| `cplace_resource_planner_configure_groups` | Configure optional first/second grouping layers |
|
|
10
|
+
| `cplace_resource_planner_configure_columns` | Configure attributesConfiguration and defaultColumnsConfiguration |
|
|
11
|
+
| `cplace_resource_planner_configure_display` | Configure visual/display settings (partial updates) |
|
|
12
|
+
|
|
13
|
+
**Workflow**:
|
|
14
|
+
1. Add resource planner widget using `cplace_define_layout` / `layout.define()` with type `cf.cplace.resourceManagement.resourcePlannerDefinition`
|
|
15
|
+
2. Configure data source: `cplace_resource_planner_configure_data_source` (node search + date calculation)
|
|
16
|
+
3. Configure display: `cplace_resource_planner_configure_display` (intervals, colors, tree structure)
|
|
17
|
+
4. Optionally configure groups: `cplace_resource_planner_configure_groups`
|
|
18
|
+
5. Configure columns: `cplace_resource_planner_configure_columns` (attributes and default columns)
|
|
19
|
+
|
|
20
|
+
**Get-Modify-Set Pattern**:
|
|
21
|
+
1. Call `cplace_resource_planner_get_configuration` to get current state
|
|
22
|
+
2. Modify the relevant section
|
|
23
|
+
3. Call the corresponding configure tool with the complete desired state
|
|
24
|
+
|
|
25
|
+
**Configuration Modes**:
|
|
26
|
+
|
|
27
|
+
**Date Calculation** (via `dateCalculation`):
|
|
28
|
+
- `STATIC`: Fixed start/end dates → activates `start`, `end`
|
|
29
|
+
- `DYNAMIC`: Relative offset from today → activates `startValueDynamic`, `startUnitDynamic`, `endValueDynamic`, `endUnitDynamic`
|
|
30
|
+
- `ATTRIBUTE`: Read from entity attributes → activates `startDateAttribute`, `endDateAttribute`
|
|
31
|
+
|
|
32
|
+
**Optional Groups**:
|
|
33
|
+
- `checkboxFirstGroup: true` → activates `searchFirstGroup`, `sortColumnFirstGroup`, `sortOrderFirstGroup`, `firstGroupSelection`, `firstGroupName`
|
|
34
|
+
- `checkboxSecondGroup: true` → activates `searchSecondGroup`, `sortColumnSecondGroup`, `sortOrderSecondGroup`, `secondGroupSelection`, `secondGroupName`
|
|
35
|
+
|
|
36
|
+
**App-Conditional Sections** (configure via generic layout tools):
|
|
37
|
+
- Actions app installed → activates `actionSearch`, `sortColumnAction`, `sortOrderAction`, `actionSelection`
|
|
38
|
+
- Chart app installed → activates `chartSearch`, `sortColumnChart`, `sortOrderChart`, `chartSelection`
|
|
39
|
+
|
|
40
|
+
**Search Triplet Pattern**: Node selection, groups, root nodes, actions, and charts all follow the same pattern: a search attribute (use cplaceJson from cplace_search_pages) + sort column + sort order.
|
|
41
|
+
|
|
42
|
+
**Version**: The `version` attribute is always set to `V2`. V1 is legacy and auto-migrated. Do not set manually.
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
**Warning**: Do not manually construct search JSON!
|
|
2
|
+
|
|
3
|
+
**Correct Usage**: Use the `cplaceJson` field from cplace_search_pages response
|
|
4
|
+
|
|
5
|
+
**Workflow**:
|
|
6
|
+
1. Call cplace_search_pages with your desired filter
|
|
7
|
+
2. Take the cplaceJson field from the response
|
|
8
|
+
3. Use that value for this attribute
|
|
9
|
+
|
|
10
|
+
**Note**: This attribute is only available when the Actions app is installed in the workspace.
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
Configure via `cplace_resource_planner_configure_columns` tool.
|
|
2
|
+
|
|
3
|
+
**JSON Format** (stored as stringified JSON):
|
|
4
|
+
```json
|
|
5
|
+
{
|
|
6
|
+
"columns": [
|
|
7
|
+
{
|
|
8
|
+
"feature": "cf.cplace.resourceManagement.startDate",
|
|
9
|
+
"header": "Start Date",
|
|
10
|
+
"builtin": true,
|
|
11
|
+
"visible": true
|
|
12
|
+
},
|
|
13
|
+
{
|
|
14
|
+
"feature": "cf.cplace.myApp.customAttribute",
|
|
15
|
+
"header": "Custom Field",
|
|
16
|
+
"builtin": false,
|
|
17
|
+
"visible": false
|
|
18
|
+
}
|
|
19
|
+
]
|
|
20
|
+
}
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
Each column entry requires all 4 fields:
|
|
24
|
+
- `feature`: Fully-qualified attribute name
|
|
25
|
+
- `header`: Display name shown in column header
|
|
26
|
+
- `builtin`: `true` for built-in columns, `false` for custom attribute columns
|
|
27
|
+
- `visible`: Whether the column is visible by default
|
|
28
|
+
|
|
29
|
+
Full replacement semantics — the provided array completely replaces the current configuration.
|
|
30
|
+
Use `cplace_resource_planner_get_configuration` to read current columns before modifying.
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
**Warning**: Do not manually construct search JSON!
|
|
2
|
+
|
|
3
|
+
**Correct Usage**: Use the `cplaceJson` field from cplace_search_pages response
|
|
4
|
+
|
|
5
|
+
**Workflow**:
|
|
6
|
+
1. Call cplace_search_pages with your desired filter
|
|
7
|
+
2. Take the cplaceJson field from the response
|
|
8
|
+
3. Use that value for this attribute
|
|
9
|
+
|
|
10
|
+
**Note**: This attribute is only available when the Chart app is installed in the workspace.
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
**Warning**: This is a mode selector that controls which period attributes are active!
|
|
2
|
+
|
|
3
|
+
**Valid Values**:
|
|
4
|
+
- `STATIC`: Fixed start/end dates (activates `start` and `end` date attributes)
|
|
5
|
+
- `DYNAMIC`: Relative to today (activates `startValueDynamic`, `startUnitDynamic`, `endValueDynamic`, `endUnitDynamic`) — most common
|
|
6
|
+
- `ATTRIBUTE`: Read from entity attributes (activates `startDateAttribute`, `endDateAttribute`)
|
|
7
|
+
|
|
8
|
+
**Note**: Only the period attributes corresponding to the selected mode are active. The others are hidden and ignored.
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
Configure via `cplace_resource_planner_configure_columns` tool.
|
|
2
|
+
|
|
3
|
+
Uses the same JSON format as `attributesConfiguration` — see that attribute's documentation for the column structure.
|
|
4
|
+
|
|
5
|
+
This attribute controls which columns are visible by default when the widget loads. The `visible` field in each column entry determines default visibility.
|
|
6
|
+
|
|
7
|
+
Full replacement semantics — use `cplace_resource_planner_get_configuration` to read current state before modifying.
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
**Warning**: Do not manually construct search JSON!
|
|
2
|
+
|
|
3
|
+
**Correct Usage**: Use the `cplaceJson` field from cplace_search_pages response
|
|
4
|
+
|
|
5
|
+
**Workflow**:
|
|
6
|
+
1. Call cplace_search_pages with your desired filter
|
|
7
|
+
2. Take the cplaceJson field from the response
|
|
8
|
+
3. Use that value for this attribute
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
**Warning**: Do not manually construct search JSON!
|
|
2
|
+
|
|
3
|
+
**Correct Usage**: Use the `cplaceJson` field from cplace_search_pages response
|
|
4
|
+
|
|
5
|
+
**Workflow**:
|
|
6
|
+
1. Call cplace_search_pages with your desired filter
|
|
7
|
+
2. Take the cplaceJson field from the response
|
|
8
|
+
3. Use that value for this attribute
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
**Warning**: Do not manually construct search JSON!
|
|
2
|
+
|
|
3
|
+
**Correct Usage**: Use the `cplaceJson` field from cplace_search_pages response
|
|
4
|
+
|
|
5
|
+
**Workflow**:
|
|
6
|
+
1. Call cplace_search_pages with your desired filter
|
|
7
|
+
2. Take the cplaceJson field from the response
|
|
8
|
+
3. Use that value for this attribute
|
|
9
|
+
|
|
10
|
+
**Note**: Root node searches often use relative UID filters. When using `relativeReference` filters, provide a real page UID as `embeddingEntityUid` — without it, the relative filter won't be included in the returned cplaceJson.
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
**Warning**: Do not manually construct search JSON!
|
|
2
|
+
|
|
3
|
+
**Correct Usage**: Use the `cplaceJson` field from cplace_search_pages response
|
|
4
|
+
|
|
5
|
+
**Workflow**:
|
|
6
|
+
1. Call cplace_search_pages with your desired filter
|
|
7
|
+
2. Take the cplaceJson field from the response
|
|
8
|
+
3. Use that value for this attribute
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
**Note**: Values represent hierarchy attributes defined on the node type. The dynamic enumeration lists attributes that can establish parent-child relationships for tree display. Select the attribute(s) that define how nodes are organized hierarchically.
|