@cyanheads/workflows-mcp-server 0.1.1
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/CLAUDE.md +376 -0
- package/Dockerfile +99 -0
- package/LICENSE +201 -0
- package/README.md +306 -0
- package/changelog/0.1.x/0.1.0.md +19 -0
- package/changelog/0.1.x/0.1.1.md +25 -0
- package/changelog/template.md +127 -0
- package/dist/config/server-config.d.ts +13 -0
- package/dist/config/server-config.d.ts.map +1 -0
- package/dist/config/server-config.js +30 -0
- package/dist/config/server-config.js.map +1 -0
- package/dist/index.d.ts +7 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +30 -0
- package/dist/index.js.map +1 -0
- package/dist/mcp-server/tools/definitions/index.d.ts +132 -0
- package/dist/mcp-server/tools/definitions/index.d.ts.map +1 -0
- package/dist/mcp-server/tools/definitions/index.js +14 -0
- package/dist/mcp-server/tools/definitions/index.js.map +1 -0
- package/dist/mcp-server/tools/definitions/workflow-create-temp.tool.d.ts +34 -0
- package/dist/mcp-server/tools/definitions/workflow-create-temp.tool.d.ts.map +1 -0
- package/dist/mcp-server/tools/definitions/workflow-create-temp.tool.js +132 -0
- package/dist/mcp-server/tools/definitions/workflow-create-temp.tool.js.map +1 -0
- package/dist/mcp-server/tools/definitions/workflow-create.tool.d.ts +40 -0
- package/dist/mcp-server/tools/definitions/workflow-create.tool.d.ts.map +1 -0
- package/dist/mcp-server/tools/definitions/workflow-create.tool.js +153 -0
- package/dist/mcp-server/tools/definitions/workflow-create.tool.js.map +1 -0
- package/dist/mcp-server/tools/definitions/workflow-get.tool.d.ts +52 -0
- package/dist/mcp-server/tools/definitions/workflow-get.tool.d.ts.map +1 -0
- package/dist/mcp-server/tools/definitions/workflow-get.tool.js +163 -0
- package/dist/mcp-server/tools/definitions/workflow-get.tool.js.map +1 -0
- package/dist/mcp-server/tools/definitions/workflow-list.tool.d.ts +28 -0
- package/dist/mcp-server/tools/definitions/workflow-list.tool.d.ts.map +1 -0
- package/dist/mcp-server/tools/definitions/workflow-list.tool.js +148 -0
- package/dist/mcp-server/tools/definitions/workflow-list.tool.js.map +1 -0
- package/dist/services/workflow-index/types.d.ts +49 -0
- package/dist/services/workflow-index/types.d.ts.map +1 -0
- package/dist/services/workflow-index/types.js +6 -0
- package/dist/services/workflow-index/types.js.map +1 -0
- package/dist/services/workflow-index/workflow-index-service.d.ts +47 -0
- package/dist/services/workflow-index/workflow-index-service.d.ts.map +1 -0
- package/dist/services/workflow-index/workflow-index-service.js +395 -0
- package/dist/services/workflow-index/workflow-index-service.js.map +1 -0
- package/package.json +103 -0
- package/server.json +129 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,201 @@
|
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(an example is provided in the Appendix below).
|
|
39
|
+
|
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
+
the Work and Derivative Works thereof.
|
|
47
|
+
|
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
|
49
|
+
the original version of the Work and any modifications or additions
|
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
+
|
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
64
|
+
subsequently incorporated within the Work.
|
|
65
|
+
|
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
|
72
|
+
|
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
+
where such license applies only to those patent claims licensable
|
|
79
|
+
by such Contributor that are necessarily infringed by their
|
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
+
institute patent litigation against any entity (including a
|
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
+
or contributory patent infringement, then any patent licenses
|
|
86
|
+
granted to You under this License for that Work shall terminate
|
|
87
|
+
as of the date such litigation is filed.
|
|
88
|
+
|
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
+
modifications, and in Source or Object form, provided that You
|
|
92
|
+
meet the following conditions:
|
|
93
|
+
|
|
94
|
+
(a) You must give any other recipients of the Work or
|
|
95
|
+
Derivative Works a copy of this License; and
|
|
96
|
+
|
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
|
98
|
+
stating that You changed the files; and
|
|
99
|
+
|
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
|
102
|
+
attribution notices from the Source form of the Work,
|
|
103
|
+
excluding those notices that do not pertain to any part of
|
|
104
|
+
the Derivative Works; and
|
|
105
|
+
|
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
|
108
|
+
include a readable copy of the attribution notices contained
|
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
|
111
|
+
of the following places: within a NOTICE text file distributed
|
|
112
|
+
as part of the Derivative Works; within the Source form or
|
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
|
114
|
+
within a display generated by the Derivative Works, if and
|
|
115
|
+
wherever such third-party notices normally appear. The contents
|
|
116
|
+
of the NOTICE file are for informational purposes only and
|
|
117
|
+
do not modify the License. You may add Your own attribution
|
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
120
|
+
that such additional attribution notices cannot be construed
|
|
121
|
+
as modifying the License.
|
|
122
|
+
|
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
|
124
|
+
may provide additional or different license terms and conditions
|
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
+
the conditions stated in this License.
|
|
129
|
+
|
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
+
this License, without any additional terms or conditions.
|
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
+
the terms of any separate license agreement you may have executed
|
|
136
|
+
with Licensor regarding such Contributions.
|
|
137
|
+
|
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
+
except as required for reasonable and customary use in describing the
|
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
142
|
+
|
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
|
152
|
+
|
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
|
158
|
+
incidental, or consequential damages of any character arising as a
|
|
159
|
+
result of this License or out of the use or inability to use the
|
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
+
other commercial damages or losses), even if such Contributor
|
|
163
|
+
has been advised of the possibility of such damages.
|
|
164
|
+
|
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
+
or other liability obligations and/or rights consistent with this
|
|
169
|
+
License. However, in accepting such obligations, You may act only
|
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
+
of your accepting any such warranty or additional liability.
|
|
175
|
+
|
|
176
|
+
END OF TERMS AND CONDITIONS
|
|
177
|
+
|
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
179
|
+
|
|
180
|
+
To apply the Apache License to your work, attach the following
|
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
182
|
+
replaced with your own identifying information. (Don't include
|
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
184
|
+
comment syntax for the file format. We also recommend that a
|
|
185
|
+
file or class name and description of purpose be included on the
|
|
186
|
+
same "printed page" as the copyright notice for easier
|
|
187
|
+
identification within third-party archives.
|
|
188
|
+
|
|
189
|
+
Copyright 2025 Casey Hand @cyanheads
|
|
190
|
+
|
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
192
|
+
you may not use this file except in compliance with the License.
|
|
193
|
+
You may obtain a copy of the License at
|
|
194
|
+
|
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
196
|
+
|
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
200
|
+
See the License for the specific language governing permissions and
|
|
201
|
+
limitations under the License.
|
package/README.md
ADDED
|
@@ -0,0 +1,306 @@
|
|
|
1
|
+
<div align="center">
|
|
2
|
+
<h1>@cyanheads/workflows-mcp-server</h1>
|
|
3
|
+
<p><b>Store, query, and create YAML workflow playbooks for LLM agents via MCP. STDIO or Streamable HTTP.</b>
|
|
4
|
+
<div>4 Tools</div>
|
|
5
|
+
</p>
|
|
6
|
+
</div>
|
|
7
|
+
|
|
8
|
+
<div align="center">
|
|
9
|
+
|
|
10
|
+
[](./CHANGELOG.md) [](./LICENSE) [](https://github.com/users/cyanheads/packages/container/package/workflows-mcp-server) [](https://modelcontextprotocol.io/) [](https://www.npmjs.com/package/@cyanheads/workflows-mcp-server) [](https://www.typescriptlang.org/) [](https://bun.sh/)
|
|
11
|
+
|
|
12
|
+
</div>
|
|
13
|
+
|
|
14
|
+
<div align="center">
|
|
15
|
+
|
|
16
|
+
[](https://github.com/cyanheads/workflows-mcp-server/releases/latest/download/workflows-mcp-server.mcpb) [](https://cursor.com/en/install-mcp?name=workflows-mcp-server&config=eyJjb21tYW5kIjoibnB4IiwiYXJncyI6WyIteSIsIkBjeWFuaGVhZHMvd29ya2Zsb3dzLW1jcC1zZXJ2ZXIiXX0=) [](https://vscode.dev/redirect?url=vscode:mcp/install?%7B%22name%22%3A%22workflows-mcp-server%22%2C%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22%40cyanheads%2Fworkflows-mcp-server%22%5D%7D)
|
|
17
|
+
|
|
18
|
+
[](https://www.npmjs.com/package/@cyanheads/mcp-ts-core)
|
|
19
|
+
|
|
20
|
+
</div>
|
|
21
|
+
|
|
22
|
+
---
|
|
23
|
+
|
|
24
|
+
## Tools
|
|
25
|
+
|
|
26
|
+
Four tools covering the full workflow library lifecycle — discovery, retrieval, and creation for both permanent and temporary workflows:
|
|
27
|
+
|
|
28
|
+
| Tool | Description |
|
|
29
|
+
|:-----|:------------|
|
|
30
|
+
| `workflow_list` | List all permanent workflows in the index, with optional category and tag filters. |
|
|
31
|
+
| `workflow_get` | Retrieve a complete workflow definition by name, with global instructions prepended. |
|
|
32
|
+
| `workflow_create` | Write a new permanent workflow YAML to the library. |
|
|
33
|
+
| `workflow_create_temp` | Write a temporary one-shot workflow, indexed but excluded from list results. |
|
|
34
|
+
|
|
35
|
+
### `workflow_list`
|
|
36
|
+
|
|
37
|
+
List permanent workflows from the in-memory index.
|
|
38
|
+
|
|
39
|
+
- Optional category filter (case-insensitive substring match)
|
|
40
|
+
- Optional tag filter (AND match — all listed tags must be present)
|
|
41
|
+
- Set `includeTools: true` to surface the unique `server/tool` pairs used across each workflow's steps
|
|
42
|
+
- Temporary workflows are excluded; results sorted by name then version descending
|
|
43
|
+
|
|
44
|
+
---
|
|
45
|
+
|
|
46
|
+
### `workflow_get`
|
|
47
|
+
|
|
48
|
+
Retrieve a complete workflow by name, including the global instructions document.
|
|
49
|
+
|
|
50
|
+
- Semver-aware: omit `version` to get the highest available match; specify a version for an exact lookup
|
|
51
|
+
- Returns the full workflow YAML structure with all steps and metadata
|
|
52
|
+
- Injects the `global_instructions.md` content as `globalInstructions` — apply these when executing the workflow; `null` when the file is absent
|
|
53
|
+
- Temporary workflows are accessible here even though excluded from `workflow_list`
|
|
54
|
+
- Template placeholders (`{{input.foo}}`, `{{steps.X.output.Y}}`) are returned verbatim — the server never interpolates them
|
|
55
|
+
|
|
56
|
+
---
|
|
57
|
+
|
|
58
|
+
### `workflow_create`
|
|
59
|
+
|
|
60
|
+
Write a new permanent workflow to the library.
|
|
61
|
+
|
|
62
|
+
- Workflow stored at `categories/<slugified-category>/<slugified-name>-workflow.yaml`
|
|
63
|
+
- Rejects if `name@version` already exists — bump the version to create a new revision
|
|
64
|
+
- Server stamps `created_date` and `last_updated_date` automatically
|
|
65
|
+
- Index and snapshot rebuilt after write; filesystem watcher also fires (idempotent, debounced)
|
|
66
|
+
|
|
67
|
+
---
|
|
68
|
+
|
|
69
|
+
### `workflow_create_temp`
|
|
70
|
+
|
|
71
|
+
Write a throwaway workflow to the `temp/` directory.
|
|
72
|
+
|
|
73
|
+
- No conflict check — temp workflows are intentionally ephemeral and overwriteable
|
|
74
|
+
- Indexed and accessible via `workflow_get` but excluded from `workflow_list` results
|
|
75
|
+
- Useful for one-shot plans, short-lived scaffolding, or session-specific orchestration steps
|
|
76
|
+
|
|
77
|
+
---
|
|
78
|
+
|
|
79
|
+
## Features
|
|
80
|
+
|
|
81
|
+
Built on [`@cyanheads/mcp-ts-core`](https://www.npmjs.com/package/@cyanheads/mcp-ts-core):
|
|
82
|
+
|
|
83
|
+
- Declarative tool definitions — single file per primitive, framework handles registration and validation
|
|
84
|
+
- Unified error handling — handlers throw, framework catches, classifies, and formats
|
|
85
|
+
- Pluggable auth: `none`, `jwt`, `oauth`
|
|
86
|
+
- Swappable storage backends: `in-memory`, `filesystem`, `Supabase`, `Cloudflare KV/R2/D1`
|
|
87
|
+
- Structured logging with optional OpenTelemetry tracing
|
|
88
|
+
- STDIO and Streamable HTTP transports
|
|
89
|
+
|
|
90
|
+
Workflow library:
|
|
91
|
+
|
|
92
|
+
- In-memory index keyed by `name@version`, built at startup from `workflows-yaml/categories/` recursively
|
|
93
|
+
- Semver-aware lookup — latest version returned when version is omitted
|
|
94
|
+
- Filesystem watcher (Node.js `fs.watch` recursive) rebuilds the index on any add/change/remove; debounced to avoid thrash
|
|
95
|
+
- YAML validated at index time — invalid files are skipped and logged, never crash the server
|
|
96
|
+
- `_index.json` snapshot written on every rebuild for external tooling and debugging
|
|
97
|
+
- Configurable `WORKFLOWS_DIR`, `GLOBAL_INSTRUCTIONS_PATH`, and debounce interval
|
|
98
|
+
|
|
99
|
+
Agent-friendly output:
|
|
100
|
+
|
|
101
|
+
- `workflow_get` always includes `globalInstructions` alongside the workflow — no second call needed
|
|
102
|
+
- Discriminated `source` field (`permanent` | `temp`) on every `workflow_get` response
|
|
103
|
+
- Typed error contracts with structured `reason` codes (`not_found`, `version_not_found`, `already_exists`, `index_unavailable`) so callers can branch on error type rather than parsing messages
|
|
104
|
+
- `workflow_list` with `includeTools: true` surfaces all MCP server/tool dependencies at a glance
|
|
105
|
+
|
|
106
|
+
---
|
|
107
|
+
|
|
108
|
+
## Getting started
|
|
109
|
+
|
|
110
|
+
No API keys required. The server reads from a local `workflows-yaml/` directory by default.
|
|
111
|
+
|
|
112
|
+
Add the following to your MCP client configuration file:
|
|
113
|
+
|
|
114
|
+
```json
|
|
115
|
+
{
|
|
116
|
+
"mcpServers": {
|
|
117
|
+
"workflows": {
|
|
118
|
+
"type": "stdio",
|
|
119
|
+
"command": "bunx",
|
|
120
|
+
"args": ["@cyanheads/workflows-mcp-server@latest"],
|
|
121
|
+
"env": {
|
|
122
|
+
"MCP_TRANSPORT_TYPE": "stdio",
|
|
123
|
+
"WORKFLOWS_DIR": "/absolute/path/to/your/workflows-yaml"
|
|
124
|
+
}
|
|
125
|
+
}
|
|
126
|
+
}
|
|
127
|
+
}
|
|
128
|
+
```
|
|
129
|
+
|
|
130
|
+
Or with npx (no Bun required):
|
|
131
|
+
|
|
132
|
+
```json
|
|
133
|
+
{
|
|
134
|
+
"mcpServers": {
|
|
135
|
+
"workflows": {
|
|
136
|
+
"type": "stdio",
|
|
137
|
+
"command": "npx",
|
|
138
|
+
"args": ["-y", "@cyanheads/workflows-mcp-server@latest"],
|
|
139
|
+
"env": {
|
|
140
|
+
"MCP_TRANSPORT_TYPE": "stdio",
|
|
141
|
+
"WORKFLOWS_DIR": "/absolute/path/to/your/workflows-yaml"
|
|
142
|
+
}
|
|
143
|
+
}
|
|
144
|
+
}
|
|
145
|
+
}
|
|
146
|
+
```
|
|
147
|
+
|
|
148
|
+
Or with Docker:
|
|
149
|
+
|
|
150
|
+
```json
|
|
151
|
+
{
|
|
152
|
+
"mcpServers": {
|
|
153
|
+
"workflows": {
|
|
154
|
+
"type": "stdio",
|
|
155
|
+
"command": "docker",
|
|
156
|
+
"args": [
|
|
157
|
+
"run", "-i", "--rm",
|
|
158
|
+
"-e", "MCP_TRANSPORT_TYPE=stdio",
|
|
159
|
+
"-v", "/absolute/path/to/your/workflows-yaml:/workflows-yaml",
|
|
160
|
+
"-e", "WORKFLOWS_DIR=/workflows-yaml",
|
|
161
|
+
"ghcr.io/cyanheads/workflows-mcp-server:latest"
|
|
162
|
+
]
|
|
163
|
+
}
|
|
164
|
+
}
|
|
165
|
+
}
|
|
166
|
+
```
|
|
167
|
+
|
|
168
|
+
For Streamable HTTP, set the transport and start the server:
|
|
169
|
+
|
|
170
|
+
```sh
|
|
171
|
+
MCP_TRANSPORT_TYPE=http MCP_HTTP_PORT=3010 bun run start:http
|
|
172
|
+
# Server listens at http://localhost:3010/mcp
|
|
173
|
+
```
|
|
174
|
+
|
|
175
|
+
### Seed workflows
|
|
176
|
+
|
|
177
|
+
The repository ships a `workflows-yaml/` directory with example workflows organized under `categories/`. These are ready to use as a starting point. The `workflows-yaml/global_instructions.md` file contains instructions the server prepends to every `workflow_get` response — edit it to set global guidance for your agent.
|
|
178
|
+
|
|
179
|
+
### Prerequisites
|
|
180
|
+
|
|
181
|
+
- [Bun v1.3.2](https://bun.sh/) or higher (or Node.js v24+).
|
|
182
|
+
- A local directory containing YAML workflow files (or use the bundled `workflows-yaml/` seed).
|
|
183
|
+
|
|
184
|
+
### Installation
|
|
185
|
+
|
|
186
|
+
1. **Clone the repository:**
|
|
187
|
+
|
|
188
|
+
```sh
|
|
189
|
+
git clone https://github.com/cyanheads/workflows-mcp-server.git
|
|
190
|
+
```
|
|
191
|
+
|
|
192
|
+
2. **Navigate into the directory:**
|
|
193
|
+
|
|
194
|
+
```sh
|
|
195
|
+
cd workflows-mcp-server
|
|
196
|
+
```
|
|
197
|
+
|
|
198
|
+
3. **Install dependencies:**
|
|
199
|
+
|
|
200
|
+
```sh
|
|
201
|
+
bun install
|
|
202
|
+
```
|
|
203
|
+
|
|
204
|
+
4. **Configure environment:**
|
|
205
|
+
|
|
206
|
+
```sh
|
|
207
|
+
cp .env.example .env
|
|
208
|
+
# edit .env if needed — most settings have defaults
|
|
209
|
+
```
|
|
210
|
+
|
|
211
|
+
---
|
|
212
|
+
|
|
213
|
+
## Configuration
|
|
214
|
+
|
|
215
|
+
| Variable | Description | Default |
|
|
216
|
+
|:---------|:------------|:--------|
|
|
217
|
+
| `WORKFLOWS_DIR` | Absolute or relative path to the workflows root directory. | `./workflows-yaml` |
|
|
218
|
+
| `GLOBAL_INSTRUCTIONS_PATH` | Path to the global instructions markdown file. Derives from `WORKFLOWS_DIR` when not set. | `<WORKFLOWS_DIR>/global_instructions.md` |
|
|
219
|
+
| `WATCHER_DEBOUNCE_MS` | Milliseconds to debounce filesystem change events before rebuilding the index. | `500` |
|
|
220
|
+
| `MCP_TRANSPORT_TYPE` | Transport: `stdio` or `http`. | `stdio` |
|
|
221
|
+
| `MCP_HTTP_PORT` | Port for HTTP server. | `3010` |
|
|
222
|
+
| `MCP_AUTH_MODE` | Auth mode: `none`, `jwt`, or `oauth`. | `none` |
|
|
223
|
+
| `MCP_LOG_LEVEL` | Log level (RFC 5424). | `info` |
|
|
224
|
+
| `OTEL_ENABLED` | Enable [OpenTelemetry instrumentation](https://github.com/cyanheads/mcp-ts-core/tree/main/docs/telemetry) (spans, metrics, completion logs). | `false` |
|
|
225
|
+
|
|
226
|
+
See [`.env.example`](./.env.example) for the full list of optional overrides.
|
|
227
|
+
|
|
228
|
+
---
|
|
229
|
+
|
|
230
|
+
## Running the server
|
|
231
|
+
|
|
232
|
+
### Local development
|
|
233
|
+
|
|
234
|
+
- **Build and run:**
|
|
235
|
+
|
|
236
|
+
```sh
|
|
237
|
+
# One-time build
|
|
238
|
+
bun run rebuild
|
|
239
|
+
|
|
240
|
+
# Run the built server
|
|
241
|
+
bun run start:stdio
|
|
242
|
+
# or
|
|
243
|
+
bun run start:http
|
|
244
|
+
```
|
|
245
|
+
|
|
246
|
+
- **Run checks and tests:**
|
|
247
|
+
|
|
248
|
+
```sh
|
|
249
|
+
bun run devcheck # Lint, format, typecheck, security
|
|
250
|
+
bun run test # Vitest test suite
|
|
251
|
+
bun run lint:mcp # Validate MCP definitions against spec
|
|
252
|
+
```
|
|
253
|
+
|
|
254
|
+
### Docker
|
|
255
|
+
|
|
256
|
+
```sh
|
|
257
|
+
docker build -t workflows-mcp-server .
|
|
258
|
+
docker run --rm \
|
|
259
|
+
-v /path/to/workflows-yaml:/workflows-yaml \
|
|
260
|
+
-e WORKFLOWS_DIR=/workflows-yaml \
|
|
261
|
+
-p 3010:3010 \
|
|
262
|
+
workflows-mcp-server
|
|
263
|
+
```
|
|
264
|
+
|
|
265
|
+
The Dockerfile defaults to HTTP transport, stateless session mode, and logs to `/var/log/workflows-mcp-server`. OpenTelemetry peer dependencies are installed by default — build with `--build-arg OTEL_ENABLED=false` to omit them.
|
|
266
|
+
|
|
267
|
+
---
|
|
268
|
+
|
|
269
|
+
## Project structure
|
|
270
|
+
|
|
271
|
+
| Directory | Purpose |
|
|
272
|
+
|:----------|:--------|
|
|
273
|
+
| `src/index.ts` | `createApp()` entry point — registers tools and inits the workflow index service. |
|
|
274
|
+
| `src/config/` | Server-specific environment variable parsing and validation with Zod. |
|
|
275
|
+
| `src/mcp-server/tools/` | Tool definitions (`*.tool.ts`). |
|
|
276
|
+
| `src/services/workflow-index/` | `WorkflowIndexService` — YAML parsing, index build, watcher, semver lookup, write helpers. |
|
|
277
|
+
| `tests/` | Unit and integration tests mirroring `src/`. |
|
|
278
|
+
| `workflows-yaml/` | Seed workflow library — `categories/` for permanent workflows, `temp/` for throwaway ones, `global_instructions.md` for agent-global guidance. |
|
|
279
|
+
|
|
280
|
+
---
|
|
281
|
+
|
|
282
|
+
## Development guide
|
|
283
|
+
|
|
284
|
+
See [`CLAUDE.md`](./CLAUDE.md) for development guidelines and architectural rules. The short version:
|
|
285
|
+
|
|
286
|
+
- Handlers throw, framework catches — no `try/catch` in tool logic
|
|
287
|
+
- Use `ctx.log` for request-scoped logging
|
|
288
|
+
- Register new tools via the barrel in `src/mcp-server/tools/definitions/index.ts`
|
|
289
|
+
- Filesystem operations go through `WorkflowIndexService`, not directly in tool handlers
|
|
290
|
+
|
|
291
|
+
---
|
|
292
|
+
|
|
293
|
+
## Contributing
|
|
294
|
+
|
|
295
|
+
Issues and pull requests are welcome. Run checks and tests before submitting:
|
|
296
|
+
|
|
297
|
+
```sh
|
|
298
|
+
bun run devcheck
|
|
299
|
+
bun run test
|
|
300
|
+
```
|
|
301
|
+
|
|
302
|
+
---
|
|
303
|
+
|
|
304
|
+
## License
|
|
305
|
+
|
|
306
|
+
Apache-2.0 — see [LICENSE](LICENSE) for details.
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
---
|
|
2
|
+
summary: "Initial release — workflow library MCP server with 4 tools, YAML-backed index, filesystem watcher, and semver-aware retrieval"
|
|
3
|
+
breaking: false
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# 0.1.0 — 2026-05-28
|
|
7
|
+
|
|
8
|
+
## Added
|
|
9
|
+
|
|
10
|
+
- `workflow_list` — list permanent workflows with optional category/tag filters; `includeTools` flag surfaces `server/tool` pairs across steps
|
|
11
|
+
- `workflow_get` — retrieve complete workflow definition by name; semver-aware (latest when version omitted); injects `global_instructions.md` content
|
|
12
|
+
- `workflow_create` — write a permanent workflow YAML to `categories/<slugified-category>/`; rejects duplicate `name@version`
|
|
13
|
+
- `workflow_create_temp` — write a temporary workflow to `temp/`; indexed but excluded from list results; no conflict check
|
|
14
|
+
- `WorkflowIndexService` — in-memory index keyed by `name@version`; YAML validation at load time (lenient — invalid files skipped and logged); filesystem watcher (Node.js `fs.watch` recursive) with configurable debounce
|
|
15
|
+
- Semver-aware lookup: highest version returned when `version` omitted on `workflow_get`
|
|
16
|
+
- `_index.json` snapshot written to workflows root on every rebuild
|
|
17
|
+
- Configurable via `WORKFLOWS_DIR`, `GLOBAL_INSTRUCTIONS_PATH`, and `WATCHER_DEBOUNCE_MS`
|
|
18
|
+
- Seed `workflows-yaml/` directory with example workflows and `global_instructions.md`
|
|
19
|
+
- STDIO and Streamable HTTP transports via `@cyanheads/mcp-ts-core ^0.9.11`
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
---
|
|
2
|
+
summary: "First real release — complete rewrite on @cyanheads/mcp-ts-core; 4 tools, YAML-backed index, filesystem watcher, semver-aware retrieval, scoped npm package @cyanheads/workflows-mcp-server"
|
|
3
|
+
breaking: true
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# 0.1.1 — 2026-05-28
|
|
7
|
+
|
|
8
|
+
Complete rewrite of `workflows-mcp-server` on `@cyanheads/mcp-ts-core ^0.9.11`. Published as `@cyanheads/workflows-mcp-server` (scoped package); the old unscoped `workflows-mcp-server@1.0.5` on npm is unchanged.
|
|
9
|
+
|
|
10
|
+
## Added
|
|
11
|
+
|
|
12
|
+
- **`workflow_list`** — list permanent workflows with optional `category` and `tags` filters (AND match); `includeTools` flag surfaces `server/tool` pairs across steps
|
|
13
|
+
- **`workflow_get`** — retrieve complete workflow definition by name; semver-aware (highest version when `version` omitted, exact match when specified); injects `global_instructions.md` content into every response
|
|
14
|
+
- **`workflow_create`** — write a permanent workflow YAML to `categories/<slugified-category>/`; rejects duplicate `name@version` to prevent silent overwrites
|
|
15
|
+
- **`workflow_create_temp`** — write a temporary workflow to `temp/`; indexed on the fly but excluded from `workflow_list` results; no conflict check
|
|
16
|
+
- **`WorkflowIndexService`** — in-memory index keyed by `name@version`; YAML validation at load (lenient — invalid files skipped and logged); native Node.js `fs.watch` recursive watcher with configurable debounce; `_index.json` snapshot written on every rebuild
|
|
17
|
+
- Seed `workflows-yaml/` with example workflows and `global_instructions.md`
|
|
18
|
+
- STDIO and Streamable HTTP transports
|
|
19
|
+
- Typed error contracts: `not_found`, `version_not_found`, `already_exists`, `index_unavailable`
|
|
20
|
+
- 71 tests across 5 files (tools + service)
|
|
21
|
+
|
|
22
|
+
## Breaking
|
|
23
|
+
|
|
24
|
+
- **Package name changed** from `workflows-mcp-server` to `@cyanheads/workflows-mcp-server` — update `package.json` and MCP config to use the scoped name
|
|
25
|
+
- Tool names, YAML schema, and env vars are new (`WORKFLOWS_DIR`, `GLOBAL_INSTRUCTIONS_PATH`, `WATCHER_DEBOUNCE_MS`); v1.x config does not carry over
|
|
@@ -0,0 +1,127 @@
|
|
|
1
|
+
---
|
|
2
|
+
# FORMAT REFERENCE — do not edit. Copy this file to
|
|
3
|
+
# `changelog/<major.minor>.x/<version>.md` (e.g. `changelog/0.8.x/0.8.6.md`)
|
|
4
|
+
# to author a new release. Set that file's H1 to `# <version> — YYYY-MM-DD`
|
|
5
|
+
# with a concrete date.
|
|
6
|
+
|
|
7
|
+
# Required. One-line GitHub Release-style headline. 350 character cap.
|
|
8
|
+
# Default short and scannable. Don't pad, don't stitch unrelated changes with
|
|
9
|
+
# semicolons — pick the headline. Quotes required: unquoted YAML treats `: `
|
|
10
|
+
# inside the value as a key separator and fails GitHub's strict parser.
|
|
11
|
+
summary: ""
|
|
12
|
+
|
|
13
|
+
# Set `true` when consumers must change code to upgrade: API removals,
|
|
14
|
+
# signature changes, config renames, behavior changes that break existing
|
|
15
|
+
# usage. Flagged as `Breaking` in the rollup.
|
|
16
|
+
breaking: false
|
|
17
|
+
|
|
18
|
+
# Set `true` if this release contains any security fix. Pairs with the
|
|
19
|
+
# `## Security` section below. Flagged as `Security` in the rollup so
|
|
20
|
+
# users can triage upgrade urgency at a glance.
|
|
21
|
+
security: false
|
|
22
|
+
|
|
23
|
+
# Optional free-form notes for maintenance agents processing this release.
|
|
24
|
+
# Not rendered in CHANGELOG — consumed by agents running `maintenance` on
|
|
25
|
+
# downstream servers. Use for adoption instructions that don't fit the
|
|
26
|
+
# human-facing sections: new files to create, fields to populate, one-time
|
|
27
|
+
# migration steps. Omit the field entirely when there's nothing to say.
|
|
28
|
+
# agent-notes: |
|
|
29
|
+
# <instructions for downstream maintenance agents>
|
|
30
|
+
---
|
|
31
|
+
|
|
32
|
+
# <version> — YYYY-MM-DD
|
|
33
|
+
|
|
34
|
+
<!--
|
|
35
|
+
AUTHORING GUIDE — applies to the new per-version file you create from this
|
|
36
|
+
template.
|
|
37
|
+
|
|
38
|
+
Audience: someone scanning release notes to decide what affects them. Lead
|
|
39
|
+
each bullet with the symbol or concept name in **bold** so they can skip
|
|
40
|
+
what's irrelevant and zoom in on what's not.
|
|
41
|
+
|
|
42
|
+
Tone: terse, fact-dense, not verbose. Default to one sentence per bullet —
|
|
43
|
+
name the symbol, state what changed, stop. Use a second sentence only when
|
|
44
|
+
it carries weight. If a bullet feels long, it is.
|
|
45
|
+
|
|
46
|
+
Cut: mechanism walkthroughs (those belong in JSDoc, AGENTS.md, or the
|
|
47
|
+
relevant skill), ceremonial framings ("This release introduces…",
|
|
48
|
+
backwards-compat paragraphs), file-by-file test enumerations, internal
|
|
49
|
+
implementation notes. Prefer code/symbol names over English re-explanations.
|
|
50
|
+
|
|
51
|
+
Narrative intro: skip by default. Add one short sentence only when the
|
|
52
|
+
release theme genuinely needs framing the bullets can't carry.
|
|
53
|
+
|
|
54
|
+
Sections: Keep a Changelog order — Added, Changed, Deprecated, Removed,
|
|
55
|
+
Fixed, Security. Include only sections with entries; delete the rest
|
|
56
|
+
(including the commented-out scaffolding below). Don't ship empty headers.
|
|
57
|
+
|
|
58
|
+
Include: every distinct fact a reader needs to adopt or audit the release —
|
|
59
|
+
new exports, signatures, lint rule IDs, env vars, breaking changes, version
|
|
60
|
+
bumps on shipped skills. Nothing more.
|
|
61
|
+
|
|
62
|
+
Links: link issues, PRs, docs, or skills where they help a reader jump to
|
|
63
|
+
context. Once per item per entry — don't re-link the same issue in summary,
|
|
64
|
+
narrative, and bullet. Skip links for inline symbol names; code spans speak
|
|
65
|
+
for themselves.
|
|
66
|
+
|
|
67
|
+
Issue/PR URLs: use full URLs. GitHub's bare `#NN` auto-link only resolves
|
|
68
|
+
inside its own UI, not in npm reads or local editors.
|
|
69
|
+
|
|
70
|
+
[#38](https://github.com/cyanheads/mcp-ts-core/issues/38) ← issue
|
|
71
|
+
[#42](https://github.com/cyanheads/mcp-ts-core/pull/42) ← PR
|
|
72
|
+
|
|
73
|
+
Verify numbers exist before linking (`gh issue view NN`, `gh pr view NN`).
|
|
74
|
+
Never speculate on a future number — `#42` for an upcoming PR silently
|
|
75
|
+
resolves to whatever real item already owns 42, and timeline previews pull
|
|
76
|
+
in that unrelated item's metadata.
|
|
77
|
+
|
|
78
|
+
TAG ANNOTATIONS — the annotated tag body renders as the GitHub Release body
|
|
79
|
+
via `gh release create --notes-from-tag`. The tag is a derivative of this
|
|
80
|
+
changelog entry — a condensed, scannable version, not a copy. Format:
|
|
81
|
+
|
|
82
|
+
<theme — omit version number, GitHub prepends it>
|
|
83
|
+
← blank line
|
|
84
|
+
<1-2 sentence context: what this release does>
|
|
85
|
+
← blank line
|
|
86
|
+
Dependency bumps: ← section header
|
|
87
|
+
← blank line
|
|
88
|
+
- `@cyanheads/mcp-ts-core` ^0.9.1 → ^0.9.6 ← bullet
|
|
89
|
+
← blank line
|
|
90
|
+
Changed: ← only sections with entries
|
|
91
|
+
← blank line
|
|
92
|
+
- `format()` output includes `query` in text mode
|
|
93
|
+
← blank line
|
|
94
|
+
Added:
|
|
95
|
+
← blank line
|
|
96
|
+
- `manifest.json` scaffolded for MCPB bundle support
|
|
97
|
+
- Install badges (Claude Desktop, Cursor, VS Code)
|
|
98
|
+
← blank line
|
|
99
|
+
<N> tests pass; `bun run devcheck` clean. ← footer
|
|
100
|
+
|
|
101
|
+
Never a flat comma-separated string. Always structured markdown with
|
|
102
|
+
sections. The tag must scan well as a rendered GitHub Release page.
|
|
103
|
+
-->
|
|
104
|
+
|
|
105
|
+
## Added
|
|
106
|
+
|
|
107
|
+
-
|
|
108
|
+
|
|
109
|
+
## Changed
|
|
110
|
+
|
|
111
|
+
-
|
|
112
|
+
|
|
113
|
+
<!-- ## Deprecated
|
|
114
|
+
|
|
115
|
+
- -->
|
|
116
|
+
|
|
117
|
+
<!-- ## Removed
|
|
118
|
+
|
|
119
|
+
- -->
|
|
120
|
+
|
|
121
|
+
## Fixed
|
|
122
|
+
|
|
123
|
+
-
|
|
124
|
+
|
|
125
|
+
<!-- ## Security
|
|
126
|
+
|
|
127
|
+
- -->
|