@betanyc/nyc-charter-laws-rules 0.1.0 → 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/README.md +52 -8
- package/package.json +17 -1
package/README.md
CHANGED
|
@@ -183,6 +183,23 @@ AML publishes updated ZIPs as new local laws and rules are adopted. Re-run `npm
|
|
|
183
183
|
|
|
184
184
|
## Installation
|
|
185
185
|
|
|
186
|
+
### npx (recommended — no install required)
|
|
187
|
+
|
|
188
|
+
```bash
|
|
189
|
+
npx @betanyc/nyc-charter-laws-rules
|
|
190
|
+
```
|
|
191
|
+
|
|
192
|
+
The corpus data is bundled in the package — no setup required.
|
|
193
|
+
|
|
194
|
+
### Global install
|
|
195
|
+
|
|
196
|
+
```bash
|
|
197
|
+
npm install -g @betanyc/nyc-charter-laws-rules
|
|
198
|
+
nyc-charter-laws-rules
|
|
199
|
+
```
|
|
200
|
+
|
|
201
|
+
### From source (for development or refreshing the index)
|
|
202
|
+
|
|
186
203
|
```bash
|
|
187
204
|
git clone https://github.com/BetaNYC/nyc-charter-laws-rules.git
|
|
188
205
|
cd nyc-charter-laws-rules
|
|
@@ -191,11 +208,40 @@ npm install
|
|
|
191
208
|
|
|
192
209
|
---
|
|
193
210
|
|
|
211
|
+
## Claude Desktop configuration
|
|
212
|
+
|
|
213
|
+
Add to your `claude_desktop_config.json`:
|
|
214
|
+
|
|
215
|
+
```json
|
|
216
|
+
{
|
|
217
|
+
"mcpServers": {
|
|
218
|
+
"nyc-charter-laws-rules": {
|
|
219
|
+
"command": "npx",
|
|
220
|
+
"args": ["-y", "@betanyc/nyc-charter-laws-rules"]
|
|
221
|
+
}
|
|
222
|
+
}
|
|
223
|
+
}
|
|
224
|
+
```
|
|
225
|
+
|
|
226
|
+
Or if installed globally:
|
|
227
|
+
|
|
228
|
+
```json
|
|
229
|
+
{
|
|
230
|
+
"mcpServers": {
|
|
231
|
+
"nyc-charter-laws-rules": {
|
|
232
|
+
"command": "nyc-charter-laws-rules"
|
|
233
|
+
}
|
|
234
|
+
}
|
|
235
|
+
}
|
|
236
|
+
```
|
|
237
|
+
|
|
238
|
+
---
|
|
239
|
+
|
|
194
240
|
## Setup
|
|
195
241
|
|
|
196
242
|
**The index is already committed — no data download needed to run the server.**
|
|
197
243
|
|
|
198
|
-
**Step 1 — Build and start the server:**
|
|
244
|
+
**Step 1 — Build and start the server (from source only):**
|
|
199
245
|
|
|
200
246
|
```bash
|
|
201
247
|
npm run build
|
|
@@ -231,24 +277,22 @@ The `data/raw/` directory is gitignored — the ZIPs will not be committed.
|
|
|
231
277
|
|
|
232
278
|
## Configuration
|
|
233
279
|
|
|
234
|
-
### Claude
|
|
280
|
+
### Claude Code
|
|
235
281
|
|
|
236
|
-
Add to your `
|
|
282
|
+
Add to your project's `.mcp.json` or `.claude/settings.json`:
|
|
237
283
|
|
|
238
284
|
```json
|
|
239
285
|
{
|
|
240
286
|
"mcpServers": {
|
|
241
287
|
"nyc-charter-laws-rules": {
|
|
242
|
-
"command": "
|
|
243
|
-
"args": ["/
|
|
288
|
+
"command": "npx",
|
|
289
|
+
"args": ["-y", "@betanyc/nyc-charter-laws-rules"]
|
|
244
290
|
}
|
|
245
291
|
}
|
|
246
292
|
}
|
|
247
293
|
```
|
|
248
294
|
|
|
249
|
-
|
|
250
|
-
|
|
251
|
-
Add to your project's `.mcp.json` or `.claude/settings.json`:
|
|
295
|
+
Or if running from a local clone:
|
|
252
296
|
|
|
253
297
|
```json
|
|
254
298
|
{
|
package/package.json
CHANGED
|
@@ -1,7 +1,23 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@betanyc/nyc-charter-laws-rules",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.1",
|
|
4
4
|
"description": "MCP server for NYC Charter, Administrative Code, and Rules of the City of New York",
|
|
5
|
+
"keywords": [
|
|
6
|
+
"mcp",
|
|
7
|
+
"model-context-protocol",
|
|
8
|
+
"ai-assistant",
|
|
9
|
+
"nyc",
|
|
10
|
+
"new-york-city",
|
|
11
|
+
"civic-tech",
|
|
12
|
+
"open-data",
|
|
13
|
+
"open-government",
|
|
14
|
+
"betanyc",
|
|
15
|
+
"nyc-charter",
|
|
16
|
+
"administrative-code",
|
|
17
|
+
"municipal-law",
|
|
18
|
+
"legal",
|
|
19
|
+
"rules"
|
|
20
|
+
],
|
|
5
21
|
"license": "MIT",
|
|
6
22
|
"author": "BetaNYC",
|
|
7
23
|
"homepage": "https://github.com/BetaNYC/nyc-charter-laws-rules",
|