@tiwater/office-mcp 0.12.0 → 0.13.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/office/README.md
CHANGED
|
@@ -1,115 +1,41 @@
|
|
|
1
1
|
# office MCP server
|
|
2
2
|
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
-
|
|
12
|
-
|
|
13
|
-
-
|
|
14
|
-
|
|
15
|
-
-
|
|
16
|
-
|
|
17
|
-
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
-
|
|
3
|
+
Published generic Office capabilities for DOCX, XLS/XLSX, and PPTX.
|
|
4
|
+
|
|
5
|
+
The server owns technical observation, native conversion, fixed-action edits,
|
|
6
|
+
package validation, and native WPS rendering. It owns no scenario meaning,
|
|
7
|
+
template-migration workflow, customer mapping, or Lucid lifecycle.
|
|
8
|
+
|
|
9
|
+
## Capability families
|
|
10
|
+
|
|
11
|
+
- DOCX: inspect document/tables, export, compare, validate OpenXML and font
|
|
12
|
+
policy, fill placeholders, transform styles, and batch one fixed edit action.
|
|
13
|
+
- XLS/XLSX: convert legacy XLS with ET, inspect/export/fill, validate, and batch
|
|
14
|
+
one fixed workbook edit action.
|
|
15
|
+
- PPTX: inspect/export/fill, bind selected masters/layouts, apply text formatting,
|
|
16
|
+
and validate OpenXML.
|
|
17
|
+
- Office: render DOC/DOCX/XLS/XLSX/PPT/PPTX to PDF with the corresponding native
|
|
18
|
+
WPS backend.
|
|
19
|
+
|
|
20
|
+
Each mutation tool fixes its provider operation type. Callers submit only the
|
|
21
|
+
coordinates and values for that action, so they cannot provide an arbitrary
|
|
22
|
+
operation discriminator or a multi-action plan language. A call may batch
|
|
23
|
+
multiple changes only when every change has the same action kind.
|
|
24
|
+
|
|
25
|
+
The catalog is intentionally open to new generic document capabilities, but a
|
|
26
|
+
scenario, template, customer, issue, work item, or model difference does not
|
|
27
|
+
justify a new tool. Add a tool only for a stable technical responsibility that
|
|
28
|
+
cannot be composed from the existing public capabilities; merge or remove
|
|
29
|
+
overlapping capabilities.
|
|
23
30
|
|
|
24
31
|
## Run
|
|
25
32
|
|
|
26
|
-
Install `@tiwater/office-mcp`
|
|
27
|
-
the consumer, then run
|
|
28
|
-
|
|
29
|
-
Office MCP 0.12 requires these minimum published runtimes on `PATH`:
|
|
30
|
-
|
|
31
|
-
| Command | Package | Minimum version |
|
|
32
|
-
| --- | --- | --- |
|
|
33
|
-
| `tiwater-docx` | NuGet `tiwater.docx.cli` | 0.15.0 |
|
|
34
|
-
| `tiwater-xlsx` | NuGet `tiwater.xlsx.cli` | 0.2.55 |
|
|
35
|
-
| `tiwater-pptx` | NuGet `tiwater.pptx.cli` | 0.3.1 |
|
|
36
|
-
| `tiwater-convert` | NuGet `tiwater.convert.cli` | 0.9.22 |
|
|
37
|
-
|
|
38
|
-
The server invokes published `tiwater-docx`, `tiwater-xlsx`,
|
|
39
|
-
`tiwater-pptx`, and `tiwater-convert` commands from `PATH`. It does not require
|
|
40
|
-
a source checkout or fall back to local projects.
|
|
41
|
-
|
|
42
|
-
The official MCP SDK derives the schemas advertised to clients and validates
|
|
43
|
-
tool arguments and structured results before they cross the protocol boundary.
|
|
44
|
-
Large observations and exports are written to a caller-selected new JSON
|
|
45
|
-
artifact. MCP returns only the artifact path, hash, and byte count.
|
|
46
|
-
|
|
47
|
-
## Workbook editing
|
|
48
|
-
|
|
49
|
-
`xlsx_apply` executes one existing `tiwater.xlsx-edit/v1` artifact against a
|
|
50
|
-
current `.xlsx` workbook. The caller's deterministic builder owns all values,
|
|
51
|
-
coordinates, and operation selection. Office MCP binds the current input,
|
|
52
|
-
operations artifact, and created output by path and content hash and records the
|
|
53
|
-
complete runtime result in a new receipt artifact. It does not interpret
|
|
54
|
-
scenario knowledge or derive workbook edits. Callers independently inspect and
|
|
55
|
-
validate the resulting workbook before delivery.
|
|
56
|
-
|
|
57
|
-
## Presentation editing
|
|
58
|
-
|
|
59
|
-
`pptx_apply_template` and `pptx_apply_format` are orthogonal execution
|
|
60
|
-
operations. The first applies a deterministic template plan to a current
|
|
61
|
-
presentation and selected current template. The second applies deterministic
|
|
62
|
-
format operations to a current presentation. Both bind their inputs, created
|
|
63
|
-
output, and complete runtime result by path and content hash. They do not select
|
|
64
|
-
templates, interpret scenario knowledge, or derive business content, slide
|
|
65
|
-
mappings, geometry, coordinates, or formatting decisions.
|
|
66
|
-
|
|
67
|
-
Callers apply a template first, inspect and validate that intermediate result,
|
|
68
|
-
then build and apply formatting against the intermediate presentation. Final
|
|
69
|
-
inspection, independent readback, native rendering, and delivery closure remain
|
|
70
|
-
separate operations.
|
|
71
|
-
|
|
72
|
-
## Template migration
|
|
73
|
-
|
|
74
|
-
Template migration separates business choice from document mechanics:
|
|
75
|
-
|
|
76
|
-
1. `docx_list_migration_choices` records the complete current source and target
|
|
77
|
-
catalog in an opaque run-local artifact.
|
|
78
|
-
2. `docx_query_migration_choices` pages source items and returns bounded,
|
|
79
|
-
document-compatible alternatives for one source item.
|
|
80
|
-
3. `docx_migrate_template` accepts one complete batch and derives the plan,
|
|
81
|
-
edits, and readback receipt.
|
|
82
|
-
4. `docx_verify_migration` independently verifies the output from the same
|
|
83
|
-
source, baseline, and batch.
|
|
84
|
-
|
|
85
|
-
The scenario supplies the business meaning. The query tool exposes three
|
|
86
|
-
orthogonal target actions:
|
|
87
|
-
|
|
88
|
-
- `place-content` moves current content into a target content position.
|
|
89
|
-
- `keep-template-label` keeps the target label and structure while migrating a
|
|
90
|
-
uniquely identified current field value.
|
|
91
|
-
- `select-template-option` marks a target option represented by the current
|
|
92
|
-
source fact.
|
|
93
|
-
|
|
94
|
-
Choose the action first, then query targets with that action filter. Returned
|
|
95
|
-
`alternativeRef` values bind the action and target together. Source exclusion
|
|
96
|
-
and genuine local review are target-free terminal choices. The caller never
|
|
97
|
-
supplies document text, selectors, coordinates, plans, or edit operations.
|
|
98
|
-
|
|
99
|
-
Template-migration choice artifacts are opaque evidence. List the choices once,
|
|
100
|
-
then query the same current source and baseline to page sources, request targets
|
|
101
|
-
for a source, or inspect cleanup targets. Target queries return complete
|
|
102
|
-
provider-compatible action-and-target alternatives under short catalog-bound
|
|
103
|
-
references. Submit selected alternatives and target-free terminal choices as
|
|
104
|
-
one batch, then verify the output independently from the same inputs and batch.
|
|
105
|
-
The tool does not choose the business mapping.
|
|
33
|
+
Install `@tiwater/office-mcp` with the exact published CLI versions required by
|
|
34
|
+
the consumer, then run:
|
|
106
35
|
|
|
107
|
-
|
|
36
|
+
```bash
|
|
37
|
+
tiwater-office-mcp
|
|
38
|
+
```
|
|
108
39
|
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
`docx_query_migration_choices`; terminal choices use `sourceRef` plus
|
|
112
|
-
`exclude-source` or `review-source`. The server rejects the old combination of
|
|
113
|
-
raw source id, action, and raw target id so an action cannot be paired with a
|
|
114
|
-
target from a different alternative. Other Office tools keep their existing
|
|
115
|
-
inputs and outputs.
|
|
40
|
+
The server uses published `tiwater-docx`, `tiwater-xlsx`,
|
|
41
|
+
`tiwater-pptx`, and `tiwater-convert` commands from `PATH`.
|