@mcp-z/cli 1.0.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.
Files changed (126) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +166 -0
  3. package/bin/cli.js +5 -0
  4. package/dist/cjs/cli.d.cts +1 -0
  5. package/dist/cjs/cli.d.ts +1 -0
  6. package/dist/cjs/cli.js +576 -0
  7. package/dist/cjs/cli.js.map +1 -0
  8. package/dist/cjs/commands/call-tool.d.cts +26 -0
  9. package/dist/cjs/commands/call-tool.d.ts +26 -0
  10. package/dist/cjs/commands/call-tool.js +362 -0
  11. package/dist/cjs/commands/call-tool.js.map +1 -0
  12. package/dist/cjs/commands/get-prompt.d.cts +26 -0
  13. package/dist/cjs/commands/get-prompt.d.ts +26 -0
  14. package/dist/cjs/commands/get-prompt.js +335 -0
  15. package/dist/cjs/commands/get-prompt.js.map +1 -0
  16. package/dist/cjs/commands/inspect.d.cts +35 -0
  17. package/dist/cjs/commands/inspect.d.ts +35 -0
  18. package/dist/cjs/commands/inspect.js +896 -0
  19. package/dist/cjs/commands/inspect.js.map +1 -0
  20. package/dist/cjs/commands/manifest/env-prompting.d.cts +21 -0
  21. package/dist/cjs/commands/manifest/env-prompting.d.ts +21 -0
  22. package/dist/cjs/commands/manifest/env-prompting.js +657 -0
  23. package/dist/cjs/commands/manifest/env-prompting.js.map +1 -0
  24. package/dist/cjs/commands/manifest/generate.d.cts +124 -0
  25. package/dist/cjs/commands/manifest/generate.d.ts +124 -0
  26. package/dist/cjs/commands/manifest/generate.js +2541 -0
  27. package/dist/cjs/commands/manifest/generate.js.map +1 -0
  28. package/dist/cjs/commands/manifest/index.d.cts +2 -0
  29. package/dist/cjs/commands/manifest/index.d.ts +2 -0
  30. package/dist/cjs/commands/manifest/index.js +229 -0
  31. package/dist/cjs/commands/manifest/index.js.map +1 -0
  32. package/dist/cjs/commands/manifest/metadata-reader.d.cts +71 -0
  33. package/dist/cjs/commands/manifest/metadata-reader.d.ts +71 -0
  34. package/dist/cjs/commands/manifest/metadata-reader.js +441 -0
  35. package/dist/cjs/commands/manifest/metadata-reader.js.map +1 -0
  36. package/dist/cjs/commands/manifest/validate.d.cts +1 -0
  37. package/dist/cjs/commands/manifest/validate.d.ts +1 -0
  38. package/dist/cjs/commands/manifest/validate.js +525 -0
  39. package/dist/cjs/commands/manifest/validate.js.map +1 -0
  40. package/dist/cjs/commands/read-resource.d.cts +24 -0
  41. package/dist/cjs/commands/read-resource.d.ts +24 -0
  42. package/dist/cjs/commands/read-resource.js +311 -0
  43. package/dist/cjs/commands/read-resource.js.map +1 -0
  44. package/dist/cjs/commands/search.d.cts +31 -0
  45. package/dist/cjs/commands/search.d.ts +31 -0
  46. package/dist/cjs/commands/search.js +464 -0
  47. package/dist/cjs/commands/search.js.map +1 -0
  48. package/dist/cjs/commands/up.d.cts +49 -0
  49. package/dist/cjs/commands/up.d.ts +49 -0
  50. package/dist/cjs/commands/up.js +235 -0
  51. package/dist/cjs/commands/up.js.map +1 -0
  52. package/dist/cjs/index.d.cts +7 -0
  53. package/dist/cjs/index.d.ts +7 -0
  54. package/dist/cjs/index.js +85 -0
  55. package/dist/cjs/index.js.map +1 -0
  56. package/dist/cjs/lib/find-config.d.cts +14 -0
  57. package/dist/cjs/lib/find-config.d.ts +14 -0
  58. package/dist/cjs/lib/find-config.js +93 -0
  59. package/dist/cjs/lib/find-config.js.map +1 -0
  60. package/dist/cjs/lib/json-schema.d.cts +18 -0
  61. package/dist/cjs/lib/json-schema.d.ts +18 -0
  62. package/dist/cjs/lib/json-schema.js +306 -0
  63. package/dist/cjs/lib/json-schema.js.map +1 -0
  64. package/dist/cjs/lib/resolve-server-config.d.cts +50 -0
  65. package/dist/cjs/lib/resolve-server-config.d.ts +50 -0
  66. package/dist/cjs/lib/resolve-server-config.js +214 -0
  67. package/dist/cjs/lib/resolve-server-config.js.map +1 -0
  68. package/dist/cjs/package.json +1 -0
  69. package/dist/cjs/types.d.cts +21 -0
  70. package/dist/cjs/types.d.ts +21 -0
  71. package/dist/cjs/types.js +32 -0
  72. package/dist/cjs/types.js.map +1 -0
  73. package/dist/esm/cli.d.ts +1 -0
  74. package/dist/esm/cli.js +129 -0
  75. package/dist/esm/cli.js.map +1 -0
  76. package/dist/esm/commands/call-tool.d.ts +26 -0
  77. package/dist/esm/commands/call-tool.js +151 -0
  78. package/dist/esm/commands/call-tool.js.map +1 -0
  79. package/dist/esm/commands/get-prompt.d.ts +26 -0
  80. package/dist/esm/commands/get-prompt.js +118 -0
  81. package/dist/esm/commands/get-prompt.js.map +1 -0
  82. package/dist/esm/commands/inspect.d.ts +35 -0
  83. package/dist/esm/commands/inspect.js +438 -0
  84. package/dist/esm/commands/inspect.js.map +1 -0
  85. package/dist/esm/commands/manifest/env-prompting.d.ts +21 -0
  86. package/dist/esm/commands/manifest/env-prompting.js +213 -0
  87. package/dist/esm/commands/manifest/env-prompting.js.map +1 -0
  88. package/dist/esm/commands/manifest/generate.d.ts +124 -0
  89. package/dist/esm/commands/manifest/generate.js +1087 -0
  90. package/dist/esm/commands/manifest/generate.js.map +1 -0
  91. package/dist/esm/commands/manifest/index.d.ts +2 -0
  92. package/dist/esm/commands/manifest/index.js +23 -0
  93. package/dist/esm/commands/manifest/index.js.map +1 -0
  94. package/dist/esm/commands/manifest/metadata-reader.d.ts +71 -0
  95. package/dist/esm/commands/manifest/metadata-reader.js +143 -0
  96. package/dist/esm/commands/manifest/metadata-reader.js.map +1 -0
  97. package/dist/esm/commands/manifest/validate.d.ts +1 -0
  98. package/dist/esm/commands/manifest/validate.js +167 -0
  99. package/dist/esm/commands/manifest/validate.js.map +1 -0
  100. package/dist/esm/commands/read-resource.d.ts +24 -0
  101. package/dist/esm/commands/read-resource.js +95 -0
  102. package/dist/esm/commands/read-resource.js.map +1 -0
  103. package/dist/esm/commands/search.d.ts +31 -0
  104. package/dist/esm/commands/search.js +145 -0
  105. package/dist/esm/commands/search.js.map +1 -0
  106. package/dist/esm/commands/up.d.ts +49 -0
  107. package/dist/esm/commands/up.js +74 -0
  108. package/dist/esm/commands/up.js.map +1 -0
  109. package/dist/esm/index.d.ts +7 -0
  110. package/dist/esm/index.js +11 -0
  111. package/dist/esm/index.js.map +1 -0
  112. package/dist/esm/lib/find-config.d.ts +14 -0
  113. package/dist/esm/lib/find-config.js +42 -0
  114. package/dist/esm/lib/find-config.js.map +1 -0
  115. package/dist/esm/lib/json-schema.d.ts +18 -0
  116. package/dist/esm/lib/json-schema.js +66 -0
  117. package/dist/esm/lib/json-schema.js.map +1 -0
  118. package/dist/esm/lib/resolve-server-config.d.ts +50 -0
  119. package/dist/esm/lib/resolve-server-config.js +154 -0
  120. package/dist/esm/lib/resolve-server-config.js.map +1 -0
  121. package/dist/esm/package.json +1 -0
  122. package/dist/esm/types.d.ts +21 -0
  123. package/dist/esm/types.js +11 -0
  124. package/dist/esm/types.js.map +1 -0
  125. package/package.json +99 -0
  126. package/schemas/server.schema.json +489 -0
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2025 Kevin Malakoff
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md ADDED
@@ -0,0 +1,166 @@
1
+ # @mcp-z/cli
2
+
3
+ Docs: https://mcp-z.github.io/cli
4
+ MCP server lifecycle management and inspection from the command line.
5
+
6
+ ## Common uses
7
+
8
+ - Spawn servers from `.mcp.json`
9
+ - Inspect tools, resources, prompts, and health
10
+ - Call tools, prompts, and resources directly
11
+ - Search capabilities across servers
12
+ - Generate or validate `server.json`
13
+
14
+ ## Install
15
+
16
+ ```bash
17
+ npm install -g @mcp-z/cli
18
+ ```
19
+
20
+ ## Quick start
21
+
22
+ ### Stdio servers
23
+
24
+ ```json
25
+ {
26
+ "mcpServers": {
27
+ "my-server": {
28
+ "command": "node",
29
+ "args": ["path/to/server.js"]
30
+ }
31
+ }
32
+ }
33
+ ```
34
+
35
+ ```bash
36
+ mcp-z up
37
+ ```
38
+
39
+ ### HTTP servers
40
+
41
+ ```json
42
+ {
43
+ "mcpServers": {
44
+ "my-server": {
45
+ "type": "http",
46
+ "url": "http://localhost:3000/mcp"
47
+ }
48
+ }
49
+ }
50
+ ```
51
+
52
+ ```bash
53
+ mcp-z up
54
+ ```
55
+
56
+ ### HTTP + start block (extension)
57
+
58
+ ```json
59
+ {
60
+ "mcpServers": {
61
+ "my-server": {
62
+ "type": "http",
63
+ "url": "http://localhost:3000/mcp",
64
+ "start": {
65
+ "command": "node",
66
+ "args": ["path/to/http-server.js"]
67
+ }
68
+ }
69
+ }
70
+ }
71
+ ```
72
+
73
+ `start` is an extension used by `npx @mcp-z/cli up` to launch HTTP servers for you.
74
+
75
+ ## Commands
76
+
77
+ ### `mcp-z up`
78
+
79
+ Start MCP servers from `.mcp.json`.
80
+
81
+ Common use cases:
82
+ - Start stdio servers for local development
83
+ - Start HTTP servers with `start` blocks
84
+
85
+ ### `mcp-z inspect`
86
+
87
+ Inspect tools, resources, prompts, and health.
88
+
89
+ Common use cases:
90
+ - See what a server exposes before writing code
91
+ - Debug startup issues
92
+
93
+ ### `mcp-z call-tool`
94
+
95
+ Call a tool with JSON arguments.
96
+
97
+ Common use cases:
98
+ - Test a tool without writing code
99
+ - Script quick one-offs
100
+
101
+ ### `mcp-z get-prompt`
102
+
103
+ Get a prompt with optional JSON arguments.
104
+
105
+ Common use cases:
106
+ - Preview prompt outputs
107
+ - Validate prompt arguments
108
+
109
+ ### `mcp-z read-resource`
110
+
111
+ Read a resource by URI.
112
+
113
+ Common use cases:
114
+ - Fetch file-backed resources
115
+ - Verify resource handlers
116
+
117
+ ### `mcp-z search`
118
+
119
+ Search tools, prompts, and resources across servers.
120
+
121
+ Common use cases:
122
+ - Discover capabilities by keyword
123
+ - Find the right tool in multi-server setups
124
+
125
+ ### `mcp-z manifest`
126
+
127
+ Generate or validate `server.json`.
128
+
129
+ Common use cases:
130
+ - Author or validate MCP server manifests
131
+
132
+ ## Inline usage
133
+
134
+ ```bash
135
+ # Stdio
136
+ mcp-z inspect --run "npx -y @modelcontextprotocol/server-everything"
137
+
138
+ # HTTP
139
+ mcp-z inspect --url "https://api.example.com/mcp"
140
+ ```
141
+
142
+ ## Configuration
143
+
144
+ MCP server config supports stdio and HTTP.
145
+
146
+ **Stdio**
147
+ ```json
148
+ {
149
+ "command": "node",
150
+ "args": ["server.js"],
151
+ "env": { "LOG_LEVEL": "info" }
152
+ }
153
+ ```
154
+
155
+ **HTTP**
156
+ ```json
157
+ {
158
+ "type": "http",
159
+ "url": "http://localhost:3000/mcp",
160
+ "headers": { "Authorization": "Bearer token" }
161
+ }
162
+ ```
163
+
164
+ ## Requirements
165
+
166
+ - Node.js >= 24
package/bin/cli.js ADDED
@@ -0,0 +1,5 @@
1
+ #!/usr/bin/env node
2
+
3
+ // biome-ignore lint/security/noGlobalEval: dual esm and cjs
4
+ if (typeof require === 'undefined') eval("import('../dist/esm/cli.js').then((cli) => cli.default(process.argv.slice(2), 'mcp-z')).catch((err) => { console.log(err); process.exit(-1); });");
5
+ else require('../dist/cjs/cli.js')(process.argv.slice(2), 'mcp-z');
@@ -0,0 +1 @@
1
+ export default function cli(argv: string[], programName: string): void;
@@ -0,0 +1 @@
1
+ export default function cli(argv: string[], programName: string): void;