@pipeworx/mcp-json 0.1.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/LICENSE +21 -0
- package/README.md +58 -0
- package/package.json +20 -0
- package/server.json +18 -0
- package/src/index.ts +92 -0
- package/tsconfig.json +14 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 Pipeworx
|
|
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,58 @@
|
|
|
1
|
+
# mcp-json
|
|
2
|
+
|
|
3
|
+
JSON tools MCP.
|
|
4
|
+
|
|
5
|
+
Part of [Pipeworx](https://pipeworx.io) — an MCP gateway connecting AI agents to 1160+ live data sources.
|
|
6
|
+
|
|
7
|
+
## Tools
|
|
8
|
+
|
|
9
|
+
| Tool | Description |
|
|
10
|
+
|------|-------------|
|
|
11
|
+
| `validate_json` | Validate a JSON string (keyless, offline). Returns whether it is valid and, if not, the error message and the character position. |
|
|
12
|
+
| `format_json` | Pretty-print or minify a JSON string. `indent` sets spaces (default 2); pass 0 to minify to a single line. Keyless, offline. |
|
|
13
|
+
| `query_json` | Extract a value from JSON at a path using dot/bracket notation, e.g. "user.addresses[0].city". Keyless, offline. |
|
|
14
|
+
|
|
15
|
+
## Quick Start
|
|
16
|
+
|
|
17
|
+
Add to your MCP client (Claude Desktop, Cursor, Windsurf, etc.):
|
|
18
|
+
|
|
19
|
+
```json
|
|
20
|
+
{
|
|
21
|
+
"mcpServers": {
|
|
22
|
+
"json": {
|
|
23
|
+
"url": "https://gateway.pipeworx.io/json/mcp"
|
|
24
|
+
}
|
|
25
|
+
}
|
|
26
|
+
}
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
Or connect to the full Pipeworx gateway for access to all 1160+ data sources:
|
|
30
|
+
|
|
31
|
+
```json
|
|
32
|
+
{
|
|
33
|
+
"mcpServers": {
|
|
34
|
+
"pipeworx": {
|
|
35
|
+
"url": "https://gateway.pipeworx.io/mcp"
|
|
36
|
+
}
|
|
37
|
+
}
|
|
38
|
+
}
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
## Using with ask_pipeworx
|
|
42
|
+
|
|
43
|
+
Instead of calling tools directly, you can ask questions in plain English:
|
|
44
|
+
|
|
45
|
+
```
|
|
46
|
+
ask_pipeworx({ question: "your question about Json data" })
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
The gateway picks the right tool and fills the arguments automatically.
|
|
50
|
+
|
|
51
|
+
## More
|
|
52
|
+
|
|
53
|
+
- [All tools and guides](https://github.com/pipeworx-io/examples)
|
|
54
|
+
- [pipeworx.io](https://pipeworx.io)
|
|
55
|
+
|
|
56
|
+
## License
|
|
57
|
+
|
|
58
|
+
MIT
|
package/package.json
ADDED
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@pipeworx/mcp-json",
|
|
3
|
+
"version": "0.1.0",
|
|
4
|
+
"description": "JSON tools MCP.",
|
|
5
|
+
"type": "module",
|
|
6
|
+
"main": "src/index.ts",
|
|
7
|
+
"types": "src/index.ts",
|
|
8
|
+
"keywords": ["mcp", "mcp-server", "model-context-protocol", "pipeworx", "json"],
|
|
9
|
+
"license": "MIT",
|
|
10
|
+
"repository": {
|
|
11
|
+
"type": "git",
|
|
12
|
+
"url": "https://github.com/pipeworx-io/mcp-json"
|
|
13
|
+
},
|
|
14
|
+
"scripts": {
|
|
15
|
+
"typecheck": "tsc --noEmit"
|
|
16
|
+
},
|
|
17
|
+
"devDependencies": {
|
|
18
|
+
"typescript": "^5.7.0"
|
|
19
|
+
}
|
|
20
|
+
}
|
package/server.json
ADDED
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
{
|
|
2
|
+
"$schema": "https://static.modelcontextprotocol.io/schemas/2025-12-11/server.schema.json",
|
|
3
|
+
"name": "io.github.pipeworx-io/json",
|
|
4
|
+
"title": "Json",
|
|
5
|
+
"description": "JSON tools MCP.",
|
|
6
|
+
"version": "0.1.0",
|
|
7
|
+
"websiteUrl": "https://pipeworx.io/packs/json",
|
|
8
|
+
"repository": {
|
|
9
|
+
"url": "https://github.com/pipeworx-io/mcp-json",
|
|
10
|
+
"source": "github"
|
|
11
|
+
},
|
|
12
|
+
"remotes": [
|
|
13
|
+
{
|
|
14
|
+
"type": "streamable-http",
|
|
15
|
+
"url": "https://gateway.pipeworx.io/json/mcp"
|
|
16
|
+
}
|
|
17
|
+
]
|
|
18
|
+
}
|
package/src/index.ts
ADDED
|
@@ -0,0 +1,92 @@
|
|
|
1
|
+
interface McpToolDefinition {
|
|
2
|
+
name: string;
|
|
3
|
+
description: string;
|
|
4
|
+
inputSchema: {
|
|
5
|
+
type: 'object';
|
|
6
|
+
properties: Record<string, unknown>;
|
|
7
|
+
required?: string[];
|
|
8
|
+
};
|
|
9
|
+
}
|
|
10
|
+
|
|
11
|
+
interface McpToolExport {
|
|
12
|
+
tools: McpToolDefinition[];
|
|
13
|
+
callTool: (name: string, args: Record<string, unknown>) => Promise<unknown>;
|
|
14
|
+
meter?: { credits: number };
|
|
15
|
+
cost?: Record<string, unknown>;
|
|
16
|
+
provider?: string;
|
|
17
|
+
}
|
|
18
|
+
|
|
19
|
+
/**
|
|
20
|
+
* JSON tools MCP.
|
|
21
|
+
*
|
|
22
|
+
* Keyless, offline: validate JSON (with the parse-error position), pretty-print
|
|
23
|
+
* or minify it, and extract a value at a dot/bracket path. Pure functions — no
|
|
24
|
+
* API, no key.
|
|
25
|
+
*/
|
|
26
|
+
|
|
27
|
+
|
|
28
|
+
const tools: McpToolExport['tools'] = [
|
|
29
|
+
{
|
|
30
|
+
name: 'validate_json',
|
|
31
|
+
description: 'Validate a JSON string (keyless, offline). Returns whether it is valid and, if not, the error message and the character position.',
|
|
32
|
+
inputSchema: { type: 'object', properties: { json: { type: 'string', description: 'The JSON text to validate.' } }, required: ['json'] },
|
|
33
|
+
},
|
|
34
|
+
{
|
|
35
|
+
name: 'format_json',
|
|
36
|
+
description: 'Pretty-print or minify a JSON string. `indent` sets spaces (default 2); pass 0 to minify to a single line. Keyless, offline.',
|
|
37
|
+
inputSchema: { type: 'object', properties: { json: { type: 'string', description: 'The JSON text.' }, indent: { type: 'number', description: 'Indent spaces (default 2; 0 = minify).' } }, required: ['json'] },
|
|
38
|
+
},
|
|
39
|
+
{
|
|
40
|
+
name: 'query_json',
|
|
41
|
+
description: 'Extract a value from JSON at a path using dot/bracket notation, e.g. "user.addresses[0].city". Keyless, offline.',
|
|
42
|
+
inputSchema: { type: 'object', properties: { json: { type: 'string', description: 'The JSON text.' }, path: { type: 'string', description: 'A path like "a.b[0].c".' } }, required: ['json', 'path'] },
|
|
43
|
+
},
|
|
44
|
+
];
|
|
45
|
+
|
|
46
|
+
function parseWithPos(text: string): { ok: true; value: unknown } | { ok: false; message: string; position: number | null } {
|
|
47
|
+
try { return { ok: true, value: JSON.parse(text) }; }
|
|
48
|
+
catch (e) {
|
|
49
|
+
const msg = (e as Error).message;
|
|
50
|
+
const m = msg.match(/position (\d+)/);
|
|
51
|
+
return { ok: false, message: msg, position: m ? +m[1] : null };
|
|
52
|
+
}
|
|
53
|
+
}
|
|
54
|
+
|
|
55
|
+
async function callTool(name: string, args: Record<string, unknown>): Promise<unknown> {
|
|
56
|
+
const json = reqStr(args, 'json', '{"a":1}');
|
|
57
|
+
switch (name) {
|
|
58
|
+
case 'validate_json': {
|
|
59
|
+
const r = parseWithPos(json);
|
|
60
|
+
return r.ok ? { valid: true } : { valid: false, error: r.message, position: r.position };
|
|
61
|
+
}
|
|
62
|
+
case 'format_json': {
|
|
63
|
+
const r = parseWithPos(json);
|
|
64
|
+
if (!r.ok) return { valid: false, error: r.message, position: r.position };
|
|
65
|
+
const indent = typeof args.indent === 'number' ? args.indent : 2;
|
|
66
|
+
return { valid: true, formatted: JSON.stringify(r.value, null, indent) };
|
|
67
|
+
}
|
|
68
|
+
case 'query_json': {
|
|
69
|
+
const r = parseWithPos(json);
|
|
70
|
+
if (!r.ok) return { valid: false, error: r.message, position: r.position };
|
|
71
|
+
const path = reqStr(args, 'path', '"a.b[0]"');
|
|
72
|
+
const keys = path.replace(/\[(\d+)\]/g, '.$1').replace(/^\./, '').split('.').filter(Boolean);
|
|
73
|
+
let cur: unknown = r.value;
|
|
74
|
+
for (const k of keys) {
|
|
75
|
+
if (cur == null || typeof cur !== 'object') return { path, found: false, reason: `Cannot descend into "${k}"; the parent is not an object/array.` };
|
|
76
|
+
cur = (cur as Record<string, unknown>)[k];
|
|
77
|
+
if (cur === undefined) return { path, found: false, reason: `Key "${k}" not found.` };
|
|
78
|
+
}
|
|
79
|
+
return { path, found: true, value: cur, type: Array.isArray(cur) ? 'array' : cur === null ? 'null' : typeof cur };
|
|
80
|
+
}
|
|
81
|
+
default:
|
|
82
|
+
throw new Error(`Unknown tool: ${name}`);
|
|
83
|
+
}
|
|
84
|
+
}
|
|
85
|
+
|
|
86
|
+
function reqStr(args: Record<string, unknown>, key: string, ex: string): string {
|
|
87
|
+
const v = args[key];
|
|
88
|
+
if (typeof v !== 'string' || !v.length) throw new Error(`Required argument "${key}" is missing. Pass a string like ${ex}.`);
|
|
89
|
+
return v;
|
|
90
|
+
}
|
|
91
|
+
|
|
92
|
+
export default { tools, callTool, meter: { credits: 1 } } satisfies McpToolExport;
|
package/tsconfig.json
ADDED
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
{
|
|
2
|
+
"compilerOptions": {
|
|
3
|
+
"target": "ES2022",
|
|
4
|
+
"module": "ESNext",
|
|
5
|
+
"moduleResolution": "bundler",
|
|
6
|
+
"strict": true,
|
|
7
|
+
"esModuleInterop": true,
|
|
8
|
+
"skipLibCheck": true,
|
|
9
|
+
"outDir": "dist",
|
|
10
|
+
"rootDir": "src",
|
|
11
|
+
"declaration": true
|
|
12
|
+
},
|
|
13
|
+
"include": ["src"]
|
|
14
|
+
}
|