Skip to content

Commit 48560c9

Browse files
committed
docs: add demo
1 parent 705efd1 commit 48560c9

File tree

1 file changed

+10
-6
lines changed

1 file changed

+10
-6
lines changed

README.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,10 @@
22

33
An MCP (Model Context Protocol) server that provides AI assistants with structured access to the [CityJSON specification](https://www.cityjson.org/specs/2.0.1/). Instead of feeding entire specifications to LLMs, this server enables AI to fetch specific chapters on demand.
44

5+
## 📺 Demo
6+
7+
<video src="https://storage.googleapis.com/cityjson/others/ci-mcp-demo.mp4" controls width="100%"></video>
8+
59
## 🚀 Quick Start
610

711
### Remote Server (Recommended)
@@ -23,13 +27,13 @@ https://cj-mcp-264879243442.europe-west4.run.app/mcp
2327
Run locally using npx:
2428

2529
```bash
26-
npx @cityjson/cj-mcp
30+
npx @cityjson/cj-mcp@latest
2731
```
2832

2933
Or install globally:
3034

3135
```bash
32-
npm install -g @cityjson/cj-mcp
36+
npm install -g @cityjson/cj-mcp@latest
3337
cityjson-spec-mcp
3438
```
3539

@@ -45,7 +49,7 @@ Add to `~/.cursor/mcp.json`:
4549
"mcpServers": {
4650
"cityjson-spec": {
4751
"command": "npx",
48-
"args": ["-y", "@cityjson/cj-mcp"]
52+
"args": ["-y", "@cityjson/cj-mcp@latest"]
4953
}
5054
}
5155
}
@@ -63,7 +67,7 @@ Add to your Claude Desktop config (`~/Library/Application Support/Claude/claude_
6367
"mcpServers": {
6468
"cityjson-spec": {
6569
"command": "npx",
66-
"args": ["-y", "@cityjson/cj-mcp"]
70+
"args": ["-y", "@cityjson/cj-mcp@latest"]
6771
}
6872
}
6973
}
@@ -83,7 +87,7 @@ Add to your VS Code settings:
8387
"cityjson-spec": {
8488
"type": "stdio",
8589
"command": "npx",
86-
"args": ["-y", "@cityjson/cj-mcp"]
90+
"args": ["-y", "@cityjson/cj-mcp@latest"]
8791
}
8892
}
8993
}
@@ -102,7 +106,7 @@ Add to your Windsurf MCP config:
102106
"mcpServers": {
103107
"cityjson-spec": {
104108
"command": "npx",
105-
"args": ["-y", "@cityjson/cj-mcp"]
109+
"args": ["-y", "@cityjson/cj-mcp@latest"]
106110
}
107111
}
108112
}

0 commit comments

Comments
 (0)