wxo-builder-mcp-server 1.0.8
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 +66 -0
- package/LICENSE +194 -0
- package/README.md +415 -0
- package/dist/agents.js +448 -0
- package/dist/auth.js +70 -0
- package/dist/config.js +39 -0
- package/dist/connections.js +191 -0
- package/dist/flows.js +73 -0
- package/dist/index.js +466 -0
- package/dist/models.js +33 -0
- package/dist/skills.js +789 -0
- package/package.json +99 -0
- package/resources/icon.png +0 -0
- package/resources/icon.svg +18 -0
- package/watson-orchestrate-openapi.json +359 -0
package/CHANGELOG.md
ADDED
|
@@ -0,0 +1,66 @@
|
|
|
1
|
+
# Changelog
|
|
2
|
+
|
|
3
|
+
All notable changes to this project will be documented in this file.
|
|
4
|
+
|
|
5
|
+
## [1.0.7] - 2026-02-21
|
|
6
|
+
|
|
7
|
+
### Fixed
|
|
8
|
+
- **Langflow DataFrame**: Flatten each row to only primitive values (string, number, boolean) so Langflow's "List items must be either all Data objects or all dictionaries" validation passes. Nested objects are JSON-stringified.
|
|
9
|
+
|
|
10
|
+
## [1.0.6] - 2026-02-21
|
|
11
|
+
|
|
12
|
+
### Fixed
|
|
13
|
+
- **Langflow compatibility**: Removed `limit` and `offset` from tool input schemas (`list_skills`, `list_agents`, `list_flows`, etc.) to avoid validation errors when Langflow sends empty strings for optional numeric params.
|
|
14
|
+
- **DataFrame compatibility**: Added `toDataFrameSafe()` so tool outputs are normalized to lists of plain objects for Langflow's MCP Tools component.
|
|
15
|
+
|
|
16
|
+
## [1.0.5] - 2026-02-20
|
|
17
|
+
|
|
18
|
+
### Added
|
|
19
|
+
- **WO_AGENT_IDs**: Optional env var for a comma-separated list of default agent IDs. When the user omits `agent_id`/`agent_name` in tool calls, the first ID is used. Tools affected: `invoke_agent`, `execute_tool`, `list_agent_tools`, `get_agent`, `get_agent_chat_starter_settings`, `update_agent_chat_starter_settings`, `update_agent`, `update_agent_instructions_from_tools`, `assign_tool_to_agent`, `create_tool_and_assign_to_agent`.
|
|
20
|
+
- **WO_AGENT_ID** (single) remains supported for backwards compatibility.
|
|
21
|
+
|
|
22
|
+
## [1.0.4] - 2026-02-20
|
|
23
|
+
|
|
24
|
+
### Added
|
|
25
|
+
- Shebang (`#!/usr/bin/env node`) for correct bin execution via npx
|
|
26
|
+
- Cursor deep link and one-click install in README (shows "WxO Builder MCP Server")
|
|
27
|
+
- MCP Registry and cursor.directory links
|
|
28
|
+
- CHANGELOG.md, CONTRIBUTING.md, and LICENSE links in README
|
|
29
|
+
- Version, date, and author in README
|
|
30
|
+
- Examples: Antigravity, Windsurf configs; `.vscode/mcp.json`, `.cursor/mcp.json`
|
|
31
|
+
- Directory listing copy (cursor.directory) section
|
|
32
|
+
|
|
33
|
+
### Changed
|
|
34
|
+
- Server name: `io.github.markusvankempen/wxo-builder-mcp-server` (was wxo-builder)
|
|
35
|
+
- server.json description shortened for MCP Registry (≤100 chars)
|
|
36
|
+
- Extension mcpClient: config from `wxo-builder` (was watsonx-orchestrate)
|
|
37
|
+
- README: npx-first config, removed ADK references, troubleshooting section
|
|
38
|
+
|
|
39
|
+
## [1.0.3] - 2026-02-20
|
|
40
|
+
|
|
41
|
+
### Added
|
|
42
|
+
- npm package published; shebang fix for npx
|
|
43
|
+
|
|
44
|
+
## [1.0.2] - 2026-02-20
|
|
45
|
+
|
|
46
|
+
### Changed
|
|
47
|
+
- Repository URLs point to standalone repo
|
|
48
|
+
- package.json repository, homepage, bugs
|
|
49
|
+
|
|
50
|
+
## [1.0.1] - 2026-02-19
|
|
51
|
+
|
|
52
|
+
### Added
|
|
53
|
+
- WxO Builder extension reference and links
|
|
54
|
+
- Distribution options (npm, standalone repo, devkit)
|
|
55
|
+
- .npmignore excludes tests/
|
|
56
|
+
|
|
57
|
+
### Changed
|
|
58
|
+
- Package name: @markusvankempen/wxo-builder-mcp-server
|
|
59
|
+
|
|
60
|
+
## [1.0.0] - 2026-02-19
|
|
61
|
+
|
|
62
|
+
### Added
|
|
63
|
+
- Initial release: tools, agents, connections, flows
|
|
64
|
+
- deploy_tool_from_url, create_tool_and_assign_to_agent
|
|
65
|
+
- Chat starter settings (welcome_message, quick_prompts)
|
|
66
|
+
- Integration tests
|
package/LICENSE
ADDED
|
@@ -0,0 +1,194 @@
|
|
|
1
|
+
Watson Orchestrate (WXO) Builder MCP Server (@markusvankempen/wxo-builder-mcp-server)
|
|
2
|
+
|
|
3
|
+
Apache License
|
|
4
|
+
Version 2.0, January 2004
|
|
5
|
+
http://www.apache.org/licenses/
|
|
6
|
+
|
|
7
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
8
|
+
|
|
9
|
+
1. Definitions.
|
|
10
|
+
|
|
11
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
12
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
13
|
+
|
|
14
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
15
|
+
the copyright owner that is granting the License.
|
|
16
|
+
|
|
17
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
18
|
+
other entities that control, are controlled by, or are under common
|
|
19
|
+
control with that entity. For the purposes of this definition,
|
|
20
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
21
|
+
direction or management of such entity, whether by contract or
|
|
22
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
23
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
24
|
+
|
|
25
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
26
|
+
exercising permissions granted by this License.
|
|
27
|
+
|
|
28
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
29
|
+
including but not limited to software source code, documentation
|
|
30
|
+
source, and configuration files.
|
|
31
|
+
|
|
32
|
+
"Object" form shall mean any form resulting from mechanical
|
|
33
|
+
transformation or translation of a Source form, including but
|
|
34
|
+
not limited to compiled object code, generated documentation,
|
|
35
|
+
and conversions to other media types.
|
|
36
|
+
|
|
37
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
38
|
+
Object form, made available under the License, as indicated by a
|
|
39
|
+
copyright notice that is included in or attached to the work
|
|
40
|
+
(an example is provided in the Appendix below).
|
|
41
|
+
|
|
42
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
43
|
+
form, that is based on (or derived from) the Work and for which the
|
|
44
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
45
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
46
|
+
of this License, Derivative Works shall not include works that remain
|
|
47
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
48
|
+
the Work and Derivative Works thereof.
|
|
49
|
+
|
|
50
|
+
"Contribution" shall mean any work of authorship, including
|
|
51
|
+
the original version of the Work and any modifications or additions
|
|
52
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
53
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
54
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
55
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
56
|
+
means any form of electronic, verbal, or written communication sent
|
|
57
|
+
to the Licensor or its representatives, including but not limited to
|
|
58
|
+
communication on electronic mailing lists, source code control systems,
|
|
59
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
60
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
61
|
+
excluding communication that is conspicuously marked or otherwise
|
|
62
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
63
|
+
|
|
64
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
65
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
66
|
+
subsequently incorporated within the Work.
|
|
67
|
+
|
|
68
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
69
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
70
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
71
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
72
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
73
|
+
Work and such Derivative Works in Source or Object form.
|
|
74
|
+
|
|
75
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
76
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
77
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
78
|
+
(except as stated in this section) patent license to make, have made,
|
|
79
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
80
|
+
where such license applies only to those patent claims licensable
|
|
81
|
+
by such Contributor that are necessarily infringed by their
|
|
82
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
83
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
84
|
+
institute patent litigation against any entity (including a
|
|
85
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
86
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
87
|
+
or contributory patent infringement, then any patent licenses
|
|
88
|
+
granted to You under this License for that Work shall terminate
|
|
89
|
+
as of the date such litigation is filed.
|
|
90
|
+
|
|
91
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
92
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
93
|
+
modifications, and in Source or Object form, provided that You
|
|
94
|
+
meet the following conditions:
|
|
95
|
+
|
|
96
|
+
(a) You must give any other recipients of the Work or Derivative
|
|
97
|
+
Works a copy of this License; and
|
|
98
|
+
|
|
99
|
+
(b) You must cause any modified files to carry prominent notices
|
|
100
|
+
stating that You changed the files; and
|
|
101
|
+
|
|
102
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
103
|
+
that You distribute, all copyright, patent, trademark, and
|
|
104
|
+
attribution notices from the Source form of the Work,
|
|
105
|
+
excluding those notices that do not pertain to any part of
|
|
106
|
+
the Derivative Works; and
|
|
107
|
+
|
|
108
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
109
|
+
distribution, then any Derivative Works that You distribute must
|
|
110
|
+
include a readable copy of the attribution notices contained
|
|
111
|
+
within such NOTICE file, excluding those notices that do not
|
|
112
|
+
pertain to any part of the Derivative Works, in at least one
|
|
113
|
+
of the following places: within a NOTICE text file distributed
|
|
114
|
+
as part of the Derivative Works; within the Source form or
|
|
115
|
+
documentation, if provided along with the Derivative Works; or,
|
|
116
|
+
within a display generated by the Derivative Works, if and
|
|
117
|
+
wherever such third-party notices normally appear. The contents
|
|
118
|
+
of the NOTICE file are for informational purposes only and
|
|
119
|
+
do not modify the License. You may add Your own attribution
|
|
120
|
+
notices within Derivative Works that You distribute, alongside
|
|
121
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
122
|
+
that such additional attribution notices cannot be construed
|
|
123
|
+
as modifying the License.
|
|
124
|
+
|
|
125
|
+
You may add Your own copyright statement to Your modifications and
|
|
126
|
+
may provide additional or different license terms and conditions
|
|
127
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
128
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
129
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
130
|
+
the conditions stated in this License.
|
|
131
|
+
|
|
132
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
133
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
134
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
135
|
+
this License, without any additional terms or conditions.
|
|
136
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
137
|
+
the terms of any separate license agreement you may have executed
|
|
138
|
+
with Licensor regarding such Contributions.
|
|
139
|
+
|
|
140
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
141
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
142
|
+
except as required for reasonable and customary use in describing the
|
|
143
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
144
|
+
|
|
145
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
146
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
147
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
148
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
149
|
+
implied, including, without limitation, any warranties or conditions
|
|
150
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
151
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
152
|
+
appropriateness of using or redistributing the Work and assume any
|
|
153
|
+
risks associated with Your exercise of permissions under this License.
|
|
154
|
+
|
|
155
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
156
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
157
|
+
unless required by applicable law (such as deliberate and grossly
|
|
158
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
159
|
+
liable to You for damages, including any direct, indirect, special,
|
|
160
|
+
incidental, or consequential damages of any character arising as a
|
|
161
|
+
result of this License or out of the use or inability to use the
|
|
162
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
163
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
164
|
+
other commercial damages or losses), even if such Contributor
|
|
165
|
+
has been advised of the possibility of such damages.
|
|
166
|
+
|
|
167
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
168
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
169
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
170
|
+
or other liability obligations and/or rights consistent with this
|
|
171
|
+
License. However, in accepting such obligations, You may act only
|
|
172
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
173
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
174
|
+
defend, and hold each Contributor harmless for any liability
|
|
175
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
176
|
+
of your accepting any such warranty or additional liability.
|
|
177
|
+
|
|
178
|
+
END OF TERMS AND CONDITIONS
|
|
179
|
+
|
|
180
|
+
Copyright 2026 Markus van Kempen <markus.van.kempen@gmail.com>
|
|
181
|
+
|
|
182
|
+
SPDX-License-Identifier: Apache-2.0
|
|
183
|
+
|
|
184
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
185
|
+
you may not use this file except in compliance with the License.
|
|
186
|
+
You may obtain a copy of the License at
|
|
187
|
+
|
|
188
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
189
|
+
|
|
190
|
+
Unless required by applicable law or agreed to in writing, software
|
|
191
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
192
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
193
|
+
See the License for the specific language governing permissions and
|
|
194
|
+
limitations under the License.
|
package/README.md
ADDED
|
@@ -0,0 +1,415 @@
|
|
|
1
|
+
# WXO Builder MCP Server
|
|
2
|
+
|
|
3
|
+
<p align="center">
|
|
4
|
+
<img src="resources/icon.svg" alt="WXO Builder MCP Server" width="96" height="96"/>
|
|
5
|
+
</p>
|
|
6
|
+
|
|
7
|
+
**Version** 1.0.4 · **Author** [Markus van Kempen](mailto:markus.van.kempen@gmail.com) · **Date** 2026-02-20
|
|
8
|
+
|
|
9
|
+
MCP server for IBM Watson Orchestrate (WXO). Manage tools, agents, connections, flows, and execute tools from Cursor, VS Code Copilot, Claude Desktop, Antigravity, Windsurf, or the WxO Builder extension.
|
|
10
|
+
|
|
11
|
+
[markusvankempen.github.io](https://markusvankempen.github.io) · [WxO Builder extension](https://marketplace.visualstudio.com/items?itemName=MarkusvanKempen.wxo-builder) · [CONTRIBUTING](CONTRIBUTING.md) · [CHANGELOG](CHANGELOG.md) · [LICENSE](LICENSE)
|
|
12
|
+
|
|
13
|
+
## Architecture & Data Flow
|
|
14
|
+
|
|
15
|
+
This package has a **dual role**:
|
|
16
|
+
|
|
17
|
+
1. **MCP protocol:** It acts as an **MCP server** — your AI environment (Cursor, Claude Desktop, VS Code Copilot, Antigravity, Windsurf, etc.) is the MCP *client* that connects to it and calls tools.
|
|
18
|
+
2. **Watson Orchestrate:** It acts as an **HTTP client** — it makes REST requests to your Watson Orchestrate instance. Watson Orchestrate never connects back to this process.
|
|
19
|
+
|
|
20
|
+
```
|
|
21
|
+
┌─────────────────────────────────┐ MCP protocol ┌──────────────────────────┐ HTTP (REST API) ┌─────────────────────────┐
|
|
22
|
+
│ MCP Client │ ◄──────────────────► │ WXO Builder MCP Server │ ───────────────────► │ Watson Orchestrate │
|
|
23
|
+
│ (Cursor, Claude Desktop, │ tool calls │ (this package) │ /v1/orchestrate/* │ instance │
|
|
24
|
+
│ Copilot, Antigravity, etc.) │ │ │ │ (your WO cloud/hosted) │
|
|
25
|
+
└─────────────────────────────────┘ └──────────────────────────┘ └─────────────────────────┘
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
The MCP server exposes tools that proxy operations to Watson Orchestrate. When you invoke a tool (e.g. `list_skills`, `invoke_agent`), the server forwards the request to the Watson Orchestrate API and returns the result.
|
|
29
|
+
|
|
30
|
+
## Related: WxO Builder Extension + MCP Server – a perfect combo
|
|
31
|
+
|
|
32
|
+
The **WxO Builder** extension and this **MCP Server** work together to create and administer Watson Orchestrate directly from your IDE. Use the extension for visual editing and the MCP server for AI-powered workflows (Cursor, Claude Desktop, etc.).
|
|
33
|
+
|
|
34
|
+
| | Link |
|
|
35
|
+
|---|------|
|
|
36
|
+
| **WxO Builder extension** | [VS Code Marketplace](https://marketplace.visualstudio.com/items?itemName=MarkusvanKempen.wxo-builder) |
|
|
37
|
+
| **Open VSX** | [open-vsx.org/extension/markusvankempen/wxo-builder](https://open-vsx.org/extension/markusvankempen/wxo-builder) |
|
|
38
|
+
| **Author** | [markusvankempen.github.io](https://markusvankempen.github.io) |
|
|
39
|
+
| **MCP Registry** | [registry.modelcontextprotocol.io/?q=wxo-builder-mcp-server](https://registry.modelcontextprotocol.io/?q=wxo-builder-mcp-server) |
|
|
40
|
+
| **Source Code** | [github.com/markusvankempen/wxo-builder-vscode-extension](https://github.com/markusvankempen/wxo-builder-vscode-extension) |
|
|
41
|
+
|
|
42
|
+
The extension provides visual tool creation, drag-and-drop agent editing, and local/remote testing. The MCP server exposes the same Watson Orchestrate capabilities to AI assistants in Cursor, Claude Desktop, Antigravity, Windsurf, and VS Code Copilot.
|
|
43
|
+
|
|
44
|
+
### Directory listing copy (cursor.directory, etc.)
|
|
45
|
+
|
|
46
|
+
**Cursor Deep Link** (use this so the install dialog shows "WxO Builder MCP Server"):
|
|
47
|
+
|
|
48
|
+
```
|
|
49
|
+
cursor://anysphere.cursor-deeplink/mcp/install?name=WxO%20Builder%20MCP%20Server&config=eyJXeE8gQnVpbGRlciBNQ1AgU2VydmVyIjp7ImNvbW1hbmQiOiJucHgiLCJhcmdzIjpbIi15IiwiQG1hcmt1c3ZhbmtlbXBlbi93eG8tYnVpbGRlci1tY3Atc2VydmVyIl0sImVudiI6eyJXT19BUElfS0VZIjoieW91ci1hcGkta2V5IiwiV09fSU5TVEFOQ0VfVVJMIjoiaHR0cHM6Ly95b3VyLWluc3RhbmNlLm9yY2hlc3RyYXRlLmlibS5jb20ifX19
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
Config JSON for [Cursor deeplink generator](https://docs.cursor.com/deeplinks):
|
|
53
|
+
|
|
54
|
+
```json
|
|
55
|
+
{
|
|
56
|
+
"WxO Builder MCP Server": {
|
|
57
|
+
"command": "npx",
|
|
58
|
+
"args": ["-y", "@markusvankempen/wxo-builder-mcp-server"],
|
|
59
|
+
"env": {
|
|
60
|
+
"WO_API_KEY": "your-api-key",
|
|
61
|
+
"WO_INSTANCE_URL": "https://your-instance.orchestrate.ibm.com",
|
|
62
|
+
"WO_AGENT_IDs": "agent-id-1,agent-id-2"
|
|
63
|
+
}
|
|
64
|
+
}
|
|
65
|
+
}
|
|
66
|
+
```
|
|
67
|
+
|
|
68
|
+
When `WO_AGENT_IDs` (comma-separated list) or `WO_AGENT_ID` is set, agent-based tools use the first ID as default when the user does not specify an agent.
|
|
69
|
+
|
|
70
|
+
**Short description (≤100 chars):**
|
|
71
|
+
|
|
72
|
+
> Manage Watson Orchestrate tools, agents, connections. Pair with [WxO Builder extension](https://marketplace.visualstudio.com/items?itemName=MarkusvanKempen.wxo-builder).
|
|
73
|
+
|
|
74
|
+
**Longer description:**
|
|
75
|
+
|
|
76
|
+
> Manage IBM Watson Orchestrate (WXO) tools, agents, connections, and flows from Cursor, Copilot, or Claude. Best used with the [WxO Builder VS Code extension](https://marketplace.visualstudio.com/items?itemName=MarkusvanKempen.wxo-builder) for a full IDE experience: visual tool creation, drag-and-drop agents, and local/remote testing.
|
|
77
|
+
|
|
78
|
+
---
|
|
79
|
+
|
|
80
|
+
**Distribution options:**
|
|
81
|
+
|
|
82
|
+
- **npm** – Install `@markusvankempen/wxo-builder-mcp-server` (recommended)
|
|
83
|
+
- **MCP Registry** – [registry.modelcontextprotocol.io/?q=wxo-builder-mcp-server](https://registry.modelcontextprotocol.io/?q=wxo-builder-mcp-server)
|
|
84
|
+
- **Standalone repo** – [github.com/markusvankempen/wxo-builder-mcp-server](https://github.com/markusvankempen/wxo-builder-mcp-server) for cloning just the MCP server
|
|
85
|
+
- **Devkit** – This package is also part of the [watsonx-orchestrate-devkit](https://github.com/markusvankempen/watsonx-orchestrate-devkit) at `packages/wxo-builder-mcp-server` (shared with the WxO Builder extension)
|
|
86
|
+
|
|
87
|
+
## Install from npm
|
|
88
|
+
|
|
89
|
+
```bash
|
|
90
|
+
npm install @markusvankempen/wxo-builder-mcp-server
|
|
91
|
+
```
|
|
92
|
+
|
|
93
|
+
### One-click install in Cursor
|
|
94
|
+
|
|
95
|
+
**[Add to Cursor](cursor://anysphere.cursor-deeplink/mcp/install?name=WxO%20Builder%20MCP%20Server&config=eyJXeE8gQnVpbGRlciBNQ1AgU2VydmVyIjp7ImNvbW1hbmQiOiJucHgiLCJhcmdzIjpbIi15IiwiQG1hcmt1c3ZhbmtlbXBlbi93eG8tYnVpbGRlci1tY3Atc2VydmVyIl0sImVudiI6eyJXT19BUElfS0VZIjoieW91ci1hcGkta2V5IiwiV09fSU5TVEFOQ0VfVVJMIjoiaHR0cHM6Ly95b3VyLWluc3RhbmNlLm9yY2hlc3RyYXRlLmlibS5jb20ifX19)** — Click to install (shows "WxO Builder MCP Server"). Then set `WO_API_KEY` and `WO_INSTANCE_URL` in Cursor MCP settings.
|
|
96
|
+
|
|
97
|
+
## Quick Start
|
|
98
|
+
|
|
99
|
+
1. **Set environment variables** (or use `.env`):
|
|
100
|
+
|
|
101
|
+
```env
|
|
102
|
+
WO_API_KEY=<your_ibm_cloud_api_key>
|
|
103
|
+
WO_INSTANCE_URL=https://<your-instance-id>.orchestrate.ibm.com
|
|
104
|
+
|
|
105
|
+
# Optional: default agent(s) when user omits agent_id/agent_name (first is used)
|
|
106
|
+
WO_AGENT_IDs=agent-id-1,agent-id-2
|
|
107
|
+
# Or single agent (backwards compatible):
|
|
108
|
+
# WO_AGENT_ID=<your-agent-id>
|
|
109
|
+
```
|
|
110
|
+
|
|
111
|
+
When `WO_AGENT_IDs` (comma-separated) or `WO_AGENT_ID` is set, tools use the first ID as default when the user does not specify an agent.
|
|
112
|
+
|
|
113
|
+
2. **Configure your MCP client** – use `npx` so you never reference `.js` paths. Example for Cursor (`.cursor/mcp.json`):
|
|
114
|
+
|
|
115
|
+
```json
|
|
116
|
+
{
|
|
117
|
+
"mcpServers": {
|
|
118
|
+
"watsonx": {
|
|
119
|
+
"command": "npx",
|
|
120
|
+
"args": ["-y", "@markusvankempen/wxo-builder-mcp-server"],
|
|
121
|
+
"env": {
|
|
122
|
+
"WO_API_KEY": "your-api-key",
|
|
123
|
+
"WO_INSTANCE_URL": "https://xxx.orchestrate.ibm.com"
|
|
124
|
+
}
|
|
125
|
+
}
|
|
126
|
+
}
|
|
127
|
+
}
|
|
128
|
+
```
|
|
129
|
+
|
|
130
|
+
VS Code Copilot uses `servers` instead of `mcpServers`; same `command` and `args`:
|
|
131
|
+
|
|
132
|
+
```json
|
|
133
|
+
{
|
|
134
|
+
"servers": {
|
|
135
|
+
"watsonx": {
|
|
136
|
+
"type": "stdio",
|
|
137
|
+
"command": "npx",
|
|
138
|
+
"args": ["-y", "@markusvankempen/wxo-builder-mcp-server"],
|
|
139
|
+
"env": {
|
|
140
|
+
"WO_API_KEY": "...",
|
|
141
|
+
"WO_INSTANCE_URL": "https://...orchestrate.ibm.com"
|
|
142
|
+
}
|
|
143
|
+
}
|
|
144
|
+
}
|
|
145
|
+
}
|
|
146
|
+
```
|
|
147
|
+
|
|
148
|
+
### Example configs
|
|
149
|
+
|
|
150
|
+
Copy-ready example files are in [`examples/`](examples/):
|
|
151
|
+
|
|
152
|
+
| File | Use for |
|
|
153
|
+
|------|---------|
|
|
154
|
+
| `examples/.vscode/mcp.json` | VS Code / GitHub Copilot → copy to `.vscode/mcp.json` |
|
|
155
|
+
| `examples/.cursor/mcp.json` | Cursor → copy to `.cursor/mcp.json` |
|
|
156
|
+
| `examples/claude-desktop-config.json` | Claude Desktop → merge into `~/Library/Application Support/Claude/claude_desktop_config.json` |
|
|
157
|
+
| `examples/antigravity-mcp-config.json` | Antigravity → add to `mcp_config.json` via Manage MCP Servers |
|
|
158
|
+
| `examples/windsurf-mcp-config.json` | Windsurf → copy to `~/.codeium/windsurf/mcp_config.json` |
|
|
159
|
+
| `examples/env.example` | Optional `.env` for env vars |
|
|
160
|
+
|
|
161
|
+
See [`examples/README.md`](examples/README.md) for details.
|
|
162
|
+
|
|
163
|
+
## Features (Parity with VS Code Extension)
|
|
164
|
+
|
|
165
|
+
### OpenAPI Spec
|
|
166
|
+
|
|
167
|
+
- **`watson-orchestrate-openapi.json`** – OpenAPI 3.0 spec describing the Watson Orchestrate REST API used by this MCP server (tools, agents, connections, flows, runs). Use `get_api_spec` to retrieve it.
|
|
168
|
+
- **`get_api_spec`** – Returns the OpenAPI spec (full or summary). Use to discover what operations the Watson Orchestrate instance supports.
|
|
169
|
+
|
|
170
|
+
### Tools (Skills)
|
|
171
|
+
|
|
172
|
+
- **`list_skills`** – List all tools in the catalog (default limit 100)
|
|
173
|
+
- **`list_tools_with_connections`** – List tools grouped by connection status (tools with connections vs standard tools). **Matches the extension Tools view.** Use for prompts like “list my Watson Orchestrate tools with active connections”.
|
|
174
|
+
- **`list_standard_tools`** – List only standard tools (no connections). Returns accurate count and list.
|
|
175
|
+
- **`get_skill`** – Get a tool by ID
|
|
176
|
+
- **`delete_skill`** – Delete a tool
|
|
177
|
+
- **`deploy_skill`** – Create a tool from OpenAPI spec. Set `openapi_spec["x-ibm-connection-id"]` to **bind a connection** to the tool
|
|
178
|
+
- **`deploy_tool_from_url`** – Create a tool from a URL. Handles (1) APIs with API key → auto-creates connection, (2) public APIs (REST Countries, Open-Meteo) → no auth.
|
|
179
|
+
- **`create_tool_and_assign_to_agent`** – Create a tool from URL and assign to agent in one step. `agent_id`/`agent_name` optional if `WO_AGENT_IDs` is set.
|
|
180
|
+
- **`assign_tool_to_agent`** – Assign a tool to an agent. `agent_id`/`agent_name` optional if `WO_AGENT_IDs` is set.
|
|
181
|
+
- **`update_skill`** – Update name, description, permission (binding/connection not editable after creation)
|
|
182
|
+
- **`copy_skill`** – Copy a tool. Use `new_name` (e.g. "MVKWeatherV2") to name the copy. Keeps connection and parameters. Names: letters, digits, underscores only.
|
|
183
|
+
- **`execute_tool`** – Execute a tool by name or ID. `agent_id` optional; uses first from `WO_AGENT_IDs` when omitted.
|
|
184
|
+
|
|
185
|
+
### Agents
|
|
186
|
+
|
|
187
|
+
- **`list_agents`** – List all agents
|
|
188
|
+
- **`get_agent`** – Get agent by ID or name. `agent_id`/`agent_name` optional if `WO_AGENT_IDs` is set.
|
|
189
|
+
- **`get_agent_chat_starter_settings`** – Get welcome message and quick prompts. `agent_id`/`agent_name` optional if `WO_AGENT_IDs` is set.
|
|
190
|
+
- **`update_agent_chat_starter_settings`** – Update `welcome_message` and `quick_prompts`. `agent_id`/`agent_name` optional if `WO_AGENT_IDs` is set.
|
|
191
|
+
- **`list_agent_tools`** – List tools assigned to an agent with display names. `agent_id`/`agent_name` optional if `WO_AGENT_IDs` is set.
|
|
192
|
+
- **`create_agent`** – Create an agent. Pass `tools` array to **assign tools** to the agent
|
|
193
|
+
- **`update_agent`** – Update an agent. `agent_id`/`agent_name` optional if `WO_AGENT_IDs` is set.
|
|
194
|
+
- **`update_agent_instructions_from_tools`** – Auto-generate and set instructions from assigned tools. `agent_id`/`agent_name` optional if `WO_AGENT_IDs` is set.
|
|
195
|
+
- **`invoke_agent`** – Chat with an agent. `agent_id`/`agent_name` optional if `WO_AGENT_IDs` is set.
|
|
196
|
+
- **`delete_agent`** – Delete an agent
|
|
197
|
+
|
|
198
|
+
### Connections
|
|
199
|
+
|
|
200
|
+
- **`list_connectors`** – List available connector catalog
|
|
201
|
+
- **`list_connections`** – List configured connections (scope: draft, live, all)
|
|
202
|
+
- **`list_active_live_connections`** – List only active and live connections (not tools), deduplicated. Use for "list all connections which are active and live, just the connections".
|
|
203
|
+
- **`get_connection`** – Get connection by app_id
|
|
204
|
+
- **`create_connection`** – Create a connection entry
|
|
205
|
+
- **`delete_connection`** – Delete a connection
|
|
206
|
+
- **`configure_connection`** – Set credentials (api_key, basic, bearer) for a connection
|
|
207
|
+
|
|
208
|
+
### Flows
|
|
209
|
+
|
|
210
|
+
- **`list_flows`**, **`get_flow`**, **`create_flow`**, **`delete_flow`**
|
|
211
|
+
|
|
212
|
+
## Client Compatibility
|
|
213
|
+
|
|
214
|
+
The MCP server is tested and works with:
|
|
215
|
+
|
|
216
|
+
| Client | Config | Notes |
|
|
217
|
+
|--------|--------|------|
|
|
218
|
+
| **Cursor** | `examples/.cursor/mcp.json` | stdio, npx or node |
|
|
219
|
+
| **VS Code Copilot** | `examples/.vscode/mcp.json` | Use `servers` key, `type: "stdio"` |
|
|
220
|
+
| **Antigravity** | `examples/antigravity-mcp-config.json` | Add via Manage MCP Servers |
|
|
221
|
+
| **Langflow** | STDIO or JSON mode | Output flattened for DataFrame; list tools have no limit/offset params |
|
|
222
|
+
|
|
223
|
+
**Langflow:** Tool output is normalized to a list of flat dicts (primitive values only) so the MCP Tools component's DataFrame validation passes. Nested objects (e.g. `binding`, `input_schema`) are JSON-stringified. Cursor, VS Code, and Antigravity receive the same format and work identically.
|
|
224
|
+
|
|
225
|
+
**Verification:** Run `npm run test:integration` with `WO_API_KEY` and `WO_INSTANCE_URL` to validate core functionality. For Cursor/VS Code: add the server, ask "List my Watson Orchestrate tools" or "Which agents do I have?" For Langflow: add MCP server, connect MCP Tools to an Agent, run the flow.
|
|
226
|
+
|
|
227
|
+
## Configuration
|
|
228
|
+
|
|
229
|
+
Set these environment variables (or use a `.env` file):
|
|
230
|
+
|
|
231
|
+
```env
|
|
232
|
+
WO_API_KEY=<your_ibm_cloud_api_key>
|
|
233
|
+
WO_INSTANCE_URL=https://<your-instance-id>.orchestrate.ibm.com
|
|
234
|
+
|
|
235
|
+
# Optional: default agent(s) when user omits agent_id/agent_name (first is used)
|
|
236
|
+
WO_AGENT_IDs=agent-id-1,agent-id-2
|
|
237
|
+
```
|
|
238
|
+
|
|
239
|
+
See [Quick Start](#quick-start) for full details on `WO_AGENT_IDs` and `WO_AGENT_ID`.
|
|
240
|
+
|
|
241
|
+
## Troubleshooting
|
|
242
|
+
|
|
243
|
+
**"Process exited with code 2" / "MCP server could not be started"**
|
|
244
|
+
|
|
245
|
+
1. **Ensure credentials are set** – `WO_API_KEY` and `WO_INSTANCE_URL` must be in your MCP config `env` block or in a `.env` file.
|
|
246
|
+
2. **Verify the server runs manually** – From a terminal:
|
|
247
|
+
```bash
|
|
248
|
+
WO_API_KEY=your-key WO_INSTANCE_URL=https://xxx.orchestrate.ibm.com npx -y @markusvankempen/wxo-builder-mcp-server
|
|
249
|
+
```
|
|
250
|
+
It should start and wait. Press Ctrl+C to exit.
|
|
251
|
+
3. **Check Node version** – Requires Node.js 18+.
|
|
252
|
+
4. **WxO Builder extension** – Ensure **API Key** and **Instance URL** are set in extension settings (search `wxo-builder` in VS Code settings).
|
|
253
|
+
|
|
254
|
+
## Running Locally
|
|
255
|
+
|
|
256
|
+
```bash
|
|
257
|
+
npm install
|
|
258
|
+
npm run build
|
|
259
|
+
node dist/index.js
|
|
260
|
+
```
|
|
261
|
+
|
|
262
|
+
## Integration Tests
|
|
263
|
+
|
|
264
|
+
The test suite validates MCP parity with the extension using **user-style test questions**. See [`tests/README.md`](tests/README.md) for full documentation. Test questions are defined in `tests/test-questions.ts` – add new ones to extend validation.
|
|
265
|
+
|
|
266
|
+
```bash
|
|
267
|
+
# With WO credentials (runs all 4 tests)
|
|
268
|
+
WO_API_KEY=... WO_INSTANCE_URL=... npm run test:integration
|
|
269
|
+
|
|
270
|
+
# Without WO credentials (runs local execution test only)
|
|
271
|
+
npm run test:integration
|
|
272
|
+
```
|
|
273
|
+
|
|
274
|
+
**Test questions:** List live connections | Copy tool with new name | List standard tools | Create MVKWeather from URL | Execute locally (Toronto) | Execute remotely | Agent chat (Toronto weather) | Exchange rate (TimeWeatherAgent) | Create REST Countries and assign to TimeWeatherAgent | List agent tools
|
|
275
|
+
|
|
276
|
+
## Assigning Tools to Agents
|
|
277
|
+
|
|
278
|
+
Use `create_agent` or `update_agent` with a `tools` array of tool IDs:
|
|
279
|
+
|
|
280
|
+
```json
|
|
281
|
+
{
|
|
282
|
+
"name": "My Agent",
|
|
283
|
+
"description": "...",
|
|
284
|
+
"model_id": "groq/openai/gpt-oss-120b",
|
|
285
|
+
"instructions": "...",
|
|
286
|
+
"tools": ["tool-id-1", "tool-id-2"]
|
|
287
|
+
}
|
|
288
|
+
```
|
|
289
|
+
|
|
290
|
+
## Assigning Connections to Tools
|
|
291
|
+
|
|
292
|
+
When deploying a tool with `deploy_skill`, include `x-ibm-connection-id` in the OpenAPI spec (or the connection’s app_id) to bind a connection:
|
|
293
|
+
|
|
294
|
+
```json
|
|
295
|
+
{
|
|
296
|
+
"tool_spec": { "name": "my_tool", "description": "..." },
|
|
297
|
+
"openapi_spec": {
|
|
298
|
+
"openapi": "3.0.1",
|
|
299
|
+
"info": { "title": "My Tool", "version": "1.0.0" },
|
|
300
|
+
"x-ibm-connection-id": "YOUR_APP_ID",
|
|
301
|
+
"paths": { ... }
|
|
302
|
+
}
|
|
303
|
+
}
|
|
304
|
+
```
|
|
305
|
+
|
|
306
|
+
## Editor configuration (VS Code, Cursor, Claude Desktop, Antigravity, Windsurf)
|
|
307
|
+
|
|
308
|
+
**Important:** MCP config does **not** go in VS Code `settings.json`. Use the correct config file for your editor.
|
|
309
|
+
|
|
310
|
+
### VS Code (with GitHub Copilot)
|
|
311
|
+
|
|
312
|
+
Config file: **`.vscode/mcp.json`** (workspace) or run **MCP: Open User Configuration** for global. Use `npx` (no .js path needed):
|
|
313
|
+
|
|
314
|
+
```json
|
|
315
|
+
{
|
|
316
|
+
"servers": {
|
|
317
|
+
"watsonx": {
|
|
318
|
+
"type": "stdio",
|
|
319
|
+
"command": "npx",
|
|
320
|
+
"args": ["-y", "@markusvankempen/wxo-builder-mcp-server"],
|
|
321
|
+
"env": {
|
|
322
|
+
"WO_API_KEY": "...",
|
|
323
|
+
"WO_INSTANCE_URL": "https://...orchestrate.ibm.com"
|
|
324
|
+
}
|
|
325
|
+
}
|
|
326
|
+
}
|
|
327
|
+
}
|
|
328
|
+
```
|
|
329
|
+
|
|
330
|
+
### Cursor
|
|
331
|
+
|
|
332
|
+
Config file: **`.cursor/mcp.json`** (project) or `~/.cursor/mcp.json` (global). Uses `mcpServers` (not `servers`). Same `command` and `args` as above.
|
|
333
|
+
|
|
334
|
+
### Antigravity (Google)
|
|
335
|
+
|
|
336
|
+
Open **Manage MCP Servers → View raw config** and add the `watsonx` entry from `examples/antigravity-mcp-config.json` to your `mcp_config.json`. Same `mcpServers` format as Cursor.
|
|
337
|
+
|
|
338
|
+
### Windsurf (Codeium)
|
|
339
|
+
|
|
340
|
+
Config file: **`~/.codeium/windsurf/mcp_config.json`** (macOS/Linux) or **`%USERPROFILE%\.codeium\windsurf\mcp_config.json`** (Windows). Use `examples/windsurf-mcp-config.json`. Same `mcpServers` format as Cursor. Restart Windsurf after changes.
|
|
341
|
+
|
|
342
|
+
### Alternative: WxO Builder extension bundled server
|
|
343
|
+
|
|
344
|
+
If you installed the WxO Builder VSIX and want to use its bundled server (no npm install), use the extension path:
|
|
345
|
+
|
|
346
|
+
```json
|
|
347
|
+
"command": "node",
|
|
348
|
+
"args": ["/Users/YOUR_USERNAME/.vscode/extensions/markusvankempen.wxo-builder-0.0.6/server/dist/index.js"]
|
|
349
|
+
```
|
|
350
|
+
|
|
351
|
+
### Local build (devkit or standalone repo)
|
|
352
|
+
|
|
353
|
+
If you clone the devkit or the [standalone repo](https://github.com/markusvankempen/wxo-builder-mcp-server), build and run via `npx` using the package directory (no .js path):
|
|
354
|
+
|
|
355
|
+
```bash
|
|
356
|
+
cd packages/wxo-builder-mcp-server # devkit
|
|
357
|
+
# or
|
|
358
|
+
cd wxo-builder-mcp-server # standalone repo
|
|
359
|
+
|
|
360
|
+
npm install && npm run build
|
|
361
|
+
```
|
|
362
|
+
|
|
363
|
+
```json
|
|
364
|
+
{
|
|
365
|
+
"servers": {
|
|
366
|
+
"watsonx": {
|
|
367
|
+
"type": "stdio",
|
|
368
|
+
"command": "npx",
|
|
369
|
+
"args": ["-y", "/path/to/wxo-builder-mcp-server"],
|
|
370
|
+
"env": {
|
|
371
|
+
"WO_API_KEY": "...",
|
|
372
|
+
"WO_INSTANCE_URL": "https://...orchestrate.ibm.com"
|
|
373
|
+
}
|
|
374
|
+
}
|
|
375
|
+
}
|
|
376
|
+
}
|
|
377
|
+
```
|
|
378
|
+
|
|
379
|
+
## Publishing (for maintainers)
|
|
380
|
+
|
|
381
|
+
### Publish to npm
|
|
382
|
+
|
|
383
|
+
From the devkit or standalone repo:
|
|
384
|
+
|
|
385
|
+
```bash
|
|
386
|
+
cd packages/wxo-builder-mcp-server # devkit
|
|
387
|
+
# or
|
|
388
|
+
cd . # standalone repo root
|
|
389
|
+
|
|
390
|
+
npm run build
|
|
391
|
+
npm publish --access public
|
|
392
|
+
```
|
|
393
|
+
|
|
394
|
+
### Publish to MCP Registry
|
|
395
|
+
|
|
396
|
+
1. Install the MCP publisher CLI: `brew install mcp-publisher`
|
|
397
|
+
2. Log in: `mcp-publisher login github`
|
|
398
|
+
3. Update `server.json` version to match `package.json`
|
|
399
|
+
4. Publish: `mcp-publisher publish`
|
|
400
|
+
|
|
401
|
+
The server will appear at [registry.modelcontextprotocol.io](https://registry.modelcontextprotocol.io) as `io.github.markusvankempen/wxo-builder-mcp-server`.
|
|
402
|
+
|
|
403
|
+
## Implementation: TypeScript vs Node.js
|
|
404
|
+
|
|
405
|
+
This MCP server is written in **TypeScript** and compiled to JavaScript. It loads an OpenAPI spec (`watson-orchestrate-openapi.json`) for documentation and discovery.
|
|
406
|
+
|
|
407
|
+
**Why TypeScript for Watson Orchestrate:**
|
|
408
|
+
|
|
409
|
+
- Larger codebase (skills, agents, connections, flows, auth, models)
|
|
410
|
+
- Type safety for Watson Orchestrate’s varied API responses
|
|
411
|
+
- Easier to maintain and extend across multiple modules
|
|
412
|
+
|
|
413
|
+
## License
|
|
414
|
+
|
|
415
|
+
Apache-2.0 — See [LICENSE](LICENSE). [CONTRIBUTING](CONTRIBUTING.md) · [CHANGELOG](CHANGELOG.md)
|