teryt-mcp 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/README.md +96 -0
- package/dist/chunk-YEPFIU35.js +2434 -0
- package/dist/cli.d.ts +30 -0
- package/dist/cli.js +127 -0
- package/dist/main.d.ts +2 -0
- package/dist/main.js +6 -0
- package/package.json +47 -0
package/README.md
ADDED
|
@@ -0,0 +1,96 @@
|
|
|
1
|
+
# TERYT MCP
|
|
2
|
+
|
|
3
|
+
MCP server for the official Polish TERYT registry.
|
|
4
|
+
|
|
5
|
+
The server exposes TERC territorial units, SIMC localities, ULIC streets, and the WMRODZ locality type dictionary through MCP tools and a small CLI. It uses the published MCP Craftman packages:
|
|
6
|
+
|
|
7
|
+
- `@mcp-craftman/core`
|
|
8
|
+
- `@mcp-craftman/node`
|
|
9
|
+
- `@mcp-craftman/cli`
|
|
10
|
+
|
|
11
|
+
## Status
|
|
12
|
+
|
|
13
|
+
This project is a single server package, not a monorepo. The reusable framework lives in the separate `mcp-craftman` repository and is consumed from npm.
|
|
14
|
+
|
|
15
|
+
## Requirements
|
|
16
|
+
|
|
17
|
+
- Node.js `>=20.19.0`
|
|
18
|
+
- pnpm `10.x`
|
|
19
|
+
|
|
20
|
+
## Install
|
|
21
|
+
|
|
22
|
+
```bash
|
|
23
|
+
pnpm install
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
## Development
|
|
27
|
+
|
|
28
|
+
```bash
|
|
29
|
+
pnpm quality
|
|
30
|
+
pnpm build
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
`pnpm quality` delegates to `mcp-craftman quality` and runs static analysis, dependency checks, architecture tests, and the unit/integration/contract test suite.
|
|
34
|
+
|
|
35
|
+
## Runtime
|
|
36
|
+
|
|
37
|
+
Build and run stdio transport:
|
|
38
|
+
|
|
39
|
+
```bash
|
|
40
|
+
pnpm build
|
|
41
|
+
node dist/main.js
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
Run HTTP transport:
|
|
45
|
+
|
|
46
|
+
```bash
|
|
47
|
+
MCP_TRANSPORT=http PORT=3000 node dist/main.js
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
Runtime configuration:
|
|
51
|
+
|
|
52
|
+
```text
|
|
53
|
+
MCP_TRANSPORT=stdio|http
|
|
54
|
+
MCP_PORT / PORT
|
|
55
|
+
MCP_DATA_DIR
|
|
56
|
+
XDG_CACHE_HOME
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
## CLI
|
|
60
|
+
|
|
61
|
+
```bash
|
|
62
|
+
pnpm build
|
|
63
|
+
node dist/cli.js status
|
|
64
|
+
node dist/cli.js source-status
|
|
65
|
+
node dist/cli.js sync --force
|
|
66
|
+
node dist/cli.js search places Kraków --limit 5
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
The CLI calls the same capabilities as MCP, so JSON output matches tool `structuredContent`.
|
|
70
|
+
|
|
71
|
+
## Tools
|
|
72
|
+
|
|
73
|
+
The public tool registry is in `src/mcp/registry.ts`.
|
|
74
|
+
|
|
75
|
+
- `health_status`
|
|
76
|
+
- `server_status`
|
|
77
|
+
- `source_status`
|
|
78
|
+
- `sync_database`
|
|
79
|
+
- `search_units`
|
|
80
|
+
- `search_places`
|
|
81
|
+
- `search_streets`
|
|
82
|
+
- `resolve_address`
|
|
83
|
+
- `get_unit`
|
|
84
|
+
- `get_place`
|
|
85
|
+
- `get_street`
|
|
86
|
+
|
|
87
|
+
See [docs/tools.md](docs/tools.md) for schemas and behavior.
|
|
88
|
+
|
|
89
|
+
## Documentation
|
|
90
|
+
|
|
91
|
+
- [docs/tools.md](docs/tools.md) - public MCP tools and CLI mapping.
|
|
92
|
+
- [docs/data-sync.md](docs/data-sync.md) - official TERYT download and SQLite build flow.
|
|
93
|
+
- [docs/quality.md](docs/quality.md) - local quality gates.
|
|
94
|
+
- [docs/architecture/feature-clean-architecture.md](docs/architecture/feature-clean-architecture.md) - feature layout and dependency rules.
|
|
95
|
+
- [docs/architecture/runtime-ecosystem.md](docs/architecture/runtime-ecosystem.md) - runtime flow and transports.
|
|
96
|
+
- [docs/architecture/package-boundaries.md](docs/architecture/package-boundaries.md) - boundary between TERYT and MCP Craftman.
|