@pipeworx/mcp-sistat-si 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 +108 -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-sistat-si
|
|
2
|
+
|
|
3
|
+
Statistical Office of the Republic of Slovenia (SURS) — SiStat PxWeb MCP.
|
|
4
|
+
|
|
5
|
+
Part of [Pipeworx](https://pipeworx.io) — an MCP gateway connecting AI agents to 965+ live data sources.
|
|
6
|
+
|
|
7
|
+
## Tools
|
|
8
|
+
|
|
9
|
+
| Tool | Description |
|
|
10
|
+
|------|-------------|
|
|
11
|
+
| `subjects` | Navigate the SiStat table tree. Nodes are folders (type "l") or tables (type "t", id ends in ".px"). Root lists tables directly. |
|
|
12
|
+
| `table_meta` | Table definition (dimensions, valid values). Path is the .px table id, e.g. "0156101S.px". |
|
|
13
|
+
| `query_table` | Pull data from a table (max 50,000,000 cells). path is the .px table id; body is a PxWeb query object. |
|
|
14
|
+
|
|
15
|
+
## Quick Start
|
|
16
|
+
|
|
17
|
+
Add to your MCP client (Claude Desktop, Cursor, Windsurf, etc.):
|
|
18
|
+
|
|
19
|
+
```json
|
|
20
|
+
{
|
|
21
|
+
"mcpServers": {
|
|
22
|
+
"sistat-si": {
|
|
23
|
+
"url": "https://gateway.pipeworx.io/sistat-si/mcp"
|
|
24
|
+
}
|
|
25
|
+
}
|
|
26
|
+
}
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
Or connect to the full Pipeworx gateway for access to all 965+ 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 Sistat Si 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-sistat-si",
|
|
3
|
+
"version": "0.1.0",
|
|
4
|
+
"description": "Statistical Office of the Republic of Slovenia (SURS) — SiStat PxWeb MCP.",
|
|
5
|
+
"type": "module",
|
|
6
|
+
"main": "src/index.ts",
|
|
7
|
+
"types": "src/index.ts",
|
|
8
|
+
"keywords": ["mcp", "mcp-server", "model-context-protocol", "pipeworx", "sistat-si"],
|
|
9
|
+
"license": "MIT",
|
|
10
|
+
"repository": {
|
|
11
|
+
"type": "git",
|
|
12
|
+
"url": "https://github.com/pipeworx-io/mcp-sistat-si"
|
|
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/sistat-si",
|
|
4
|
+
"title": "Sistat Si",
|
|
5
|
+
"description": "Statistical Office of the Republic of Slovenia (SURS) — SiStat PxWeb MCP.",
|
|
6
|
+
"version": "0.1.0",
|
|
7
|
+
"websiteUrl": "https://pipeworx.io/packs/sistat-si",
|
|
8
|
+
"repository": {
|
|
9
|
+
"url": "https://github.com/pipeworx-io/mcp-sistat-si",
|
|
10
|
+
"source": "github"
|
|
11
|
+
},
|
|
12
|
+
"remotes": [
|
|
13
|
+
{
|
|
14
|
+
"type": "streamable-http",
|
|
15
|
+
"url": "https://gateway.pipeworx.io/sistat-si/mcp"
|
|
16
|
+
}
|
|
17
|
+
]
|
|
18
|
+
}
|
package/src/index.ts
ADDED
|
@@ -0,0 +1,108 @@
|
|
|
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
|
+
* Statistical Office of the Republic of Slovenia (SURS) — SiStat PxWeb MCP.
|
|
21
|
+
*
|
|
22
|
+
* Keyless PxWeb v1 API. Base: https://pxweb.stat.si/SiStatData/api/v1/en
|
|
23
|
+
* Note the extra /Data/ segment after /en that holds the table tree.
|
|
24
|
+
*
|
|
25
|
+
* Tree nodes: type "l" = folder, type "t" = table. The SiStat root (/Data/)
|
|
26
|
+
* is flat — it lists ~4,700 tables directly (no folders), but the PxWeb API
|
|
27
|
+
* still supports nested sub-paths the same way as any PxWeb instance.
|
|
28
|
+
*
|
|
29
|
+
* Tables are addressed by their .px id (e.g. "0156101S.px"). GET the .px path
|
|
30
|
+
* for metadata (dimensions + valid values); POST a PxWeb query body to it for
|
|
31
|
+
* data. Query limits (from /en/?config): maxCells/maxValues 50,000,000,
|
|
32
|
+
* maxCalls 500 per 10s window.
|
|
33
|
+
*/
|
|
34
|
+
|
|
35
|
+
|
|
36
|
+
const BASE = 'https://pxweb.stat.si/SiStatData/api/v1/en/Data';
|
|
37
|
+
const UA = 'pipeworx-mcp-sistat-si/1.0 (+https://pipeworx.io)';
|
|
38
|
+
|
|
39
|
+
const tools: McpToolExport['tools'] = [
|
|
40
|
+
{
|
|
41
|
+
name: 'subjects',
|
|
42
|
+
description: 'Navigate the SiStat table tree. Nodes are folders (type "l") or tables (type "t", id ends in ".px"). Root lists tables directly.',
|
|
43
|
+
inputSchema: {
|
|
44
|
+
type: 'object',
|
|
45
|
+
properties: { path: { type: 'string', description: 'Sub-path under /Data/ (default empty = root).' } },
|
|
46
|
+
},
|
|
47
|
+
},
|
|
48
|
+
{
|
|
49
|
+
name: 'table_meta',
|
|
50
|
+
description: 'Table definition (dimensions, valid values). Path is the .px table id, e.g. "0156101S.px".',
|
|
51
|
+
inputSchema: {
|
|
52
|
+
type: 'object',
|
|
53
|
+
properties: { path: { type: 'string', description: 'e.g. "0156101S.px" (include the .px suffix)' } },
|
|
54
|
+
required: ['path'],
|
|
55
|
+
},
|
|
56
|
+
},
|
|
57
|
+
{
|
|
58
|
+
name: 'query_table',
|
|
59
|
+
description: 'Pull data from a table (max 50,000,000 cells). path is the .px table id; body is a PxWeb query object.',
|
|
60
|
+
inputSchema: {
|
|
61
|
+
type: 'object',
|
|
62
|
+
properties: {
|
|
63
|
+
path: { type: 'string', description: 'e.g. "0156101S.px"' },
|
|
64
|
+
body: { type: 'object', description: '{query: [{code, selection: {filter, values}}], response: {format: "json-stat2"}}' },
|
|
65
|
+
},
|
|
66
|
+
required: ['path', 'body'],
|
|
67
|
+
},
|
|
68
|
+
},
|
|
69
|
+
];
|
|
70
|
+
|
|
71
|
+
async function callTool(name: string, args: Record<string, unknown>): Promise<unknown> {
|
|
72
|
+
switch (name) {
|
|
73
|
+
case 'subjects': {
|
|
74
|
+
const path = (args.path as string | undefined)?.replace(/^\/+|\/+$/g, '') ?? '';
|
|
75
|
+
return sistatGet(path ? `/${path}` : '');
|
|
76
|
+
}
|
|
77
|
+
case 'table_meta':
|
|
78
|
+
return sistatGet(`/${reqStr(args, 'path', '"0156101S.px"').replace(/^\/+|\/+$/g, '')}`);
|
|
79
|
+
case 'query_table': {
|
|
80
|
+
const path = reqStr(args, 'path', '"0156101S.px"').replace(/^\/+|\/+$/g, '');
|
|
81
|
+
const body = args.body;
|
|
82
|
+
if (!body || typeof body !== 'object') throw new Error('body must be a PxWeb query object.');
|
|
83
|
+
const res = await fetch(`${BASE}/${path}`, {
|
|
84
|
+
method: 'POST',
|
|
85
|
+
headers: { 'Content-Type': 'application/json', Accept: 'application/json', 'User-Agent': UA },
|
|
86
|
+
body: JSON.stringify(body),
|
|
87
|
+
});
|
|
88
|
+
if (!res.ok) throw new Error(`SiStat: ${res.status} ${await res.text().then((t) => t.slice(0, 200))}`);
|
|
89
|
+
return res.json();
|
|
90
|
+
}
|
|
91
|
+
default:
|
|
92
|
+
throw new Error(`Unknown tool: ${name}`);
|
|
93
|
+
}
|
|
94
|
+
}
|
|
95
|
+
|
|
96
|
+
async function sistatGet(path: string): Promise<unknown> {
|
|
97
|
+
const res = await fetch(`${BASE}${path}`, { headers: { Accept: 'application/json', 'User-Agent': UA } });
|
|
98
|
+
if (!res.ok) throw new Error(`SiStat: ${res.status} ${await res.text().then((t) => t.slice(0, 200))}`);
|
|
99
|
+
return res.json();
|
|
100
|
+
}
|
|
101
|
+
|
|
102
|
+
function reqStr(args: Record<string, unknown>, key: string, example: string): string {
|
|
103
|
+
const v = args[key];
|
|
104
|
+
if (typeof v !== 'string' || !v.trim()) throw new Error(`Required argument "${key}" is missing. Pass a string like ${example}.`);
|
|
105
|
+
return v;
|
|
106
|
+
}
|
|
107
|
+
|
|
108
|
+
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
|
+
}
|