@voidly/mcp-server 1.0.0 → 1.0.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 +49 -46
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,26 +1,20 @@
|
|
|
1
1
|
# Voidly MCP Server
|
|
2
2
|
|
|
3
|
-
Model Context Protocol (MCP) server for the **Voidly Global Censorship Index**. Enables AI systems
|
|
3
|
+
Model Context Protocol (MCP) server for the **Voidly Global Censorship Index**. Enables AI systems to query real-time internet censorship data.
|
|
4
4
|
|
|
5
|
-
##
|
|
5
|
+
## Data Scale
|
|
6
6
|
|
|
7
|
-
- **
|
|
8
|
-
- **
|
|
9
|
-
- **
|
|
10
|
-
-
|
|
11
|
-
|
|
12
|
-
## Tools
|
|
13
|
-
|
|
14
|
-
| Tool | Description |
|
|
15
|
-
|------|-------------|
|
|
16
|
-
| `get_censorship_index` | Global overview of all monitored countries |
|
|
17
|
-
| `get_country_status` | Detailed status for a specific country |
|
|
18
|
-
| `check_domain_blocked` | Check if a domain is blocked in a country |
|
|
19
|
-
| `get_most_censored` | Ranked list of most censored countries |
|
|
20
|
-
| `get_active_incidents` | Currently active censorship incidents |
|
|
7
|
+
- **11.7M** live OONI measurements
|
|
8
|
+
- **1B+** historical measurements (10-year archive)
|
|
9
|
+
- **120+** countries monitored
|
|
10
|
+
- Updated every 5 minutes
|
|
21
11
|
|
|
22
12
|
## Installation
|
|
23
13
|
|
|
14
|
+
```bash
|
|
15
|
+
npx @voidly/mcp-server
|
|
16
|
+
```
|
|
17
|
+
|
|
24
18
|
### Claude Desktop
|
|
25
19
|
|
|
26
20
|
Add to `~/Library/Application Support/Claude/claude_desktop_config.json`:
|
|
@@ -29,37 +23,41 @@ Add to `~/Library/Application Support/Claude/claude_desktop_config.json`:
|
|
|
29
23
|
{
|
|
30
24
|
"mcpServers": {
|
|
31
25
|
"voidly": {
|
|
32
|
-
"command": "
|
|
33
|
-
"args": ["
|
|
26
|
+
"command": "npx",
|
|
27
|
+
"args": ["@voidly/mcp-server"]
|
|
34
28
|
}
|
|
35
29
|
}
|
|
36
30
|
}
|
|
37
31
|
```
|
|
38
32
|
|
|
39
|
-
###
|
|
33
|
+
### Cursor / Windsurf / Cline
|
|
40
34
|
|
|
41
|
-
Add to your
|
|
35
|
+
Add to your MCP config:
|
|
42
36
|
|
|
43
37
|
```json
|
|
44
38
|
{
|
|
45
39
|
"mcpServers": {
|
|
46
40
|
"voidly": {
|
|
47
|
-
"command": "
|
|
48
|
-
"args": ["
|
|
41
|
+
"command": "npx",
|
|
42
|
+
"args": ["@voidly/mcp-server"]
|
|
49
43
|
}
|
|
50
44
|
}
|
|
51
45
|
}
|
|
52
46
|
```
|
|
53
47
|
|
|
54
|
-
|
|
48
|
+
## Tools
|
|
55
49
|
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
50
|
+
| Tool | Description |
|
|
51
|
+
|------|-------------|
|
|
52
|
+
| `get_censorship_index` | Global overview of all monitored countries |
|
|
53
|
+
| `get_country_status` | Detailed status for a specific country |
|
|
54
|
+
| `check_domain_blocked` | Check if a domain is blocked in a country |
|
|
55
|
+
| `get_most_censored` | Ranked list of most censored countries |
|
|
56
|
+
| `get_active_incidents` | Currently active censorship incidents |
|
|
59
57
|
|
|
60
58
|
## Usage Examples
|
|
61
59
|
|
|
62
|
-
Once configured, you can ask
|
|
60
|
+
Once configured, you can ask:
|
|
63
61
|
|
|
64
62
|
- "What countries have the most internet censorship?"
|
|
65
63
|
- "Is the internet censored in China?"
|
|
@@ -67,38 +65,43 @@ Once configured, you can ask Claude:
|
|
|
67
65
|
- "Are there any active internet shutdowns?"
|
|
68
66
|
- "Is Twitter blocked in Russia?"
|
|
69
67
|
|
|
68
|
+
## Other AI Platforms
|
|
69
|
+
|
|
70
|
+
### OpenAI / ChatGPT
|
|
71
|
+
|
|
72
|
+
MCP isn't supported by OpenAI yet. Use our **OpenAI Action** instead:
|
|
73
|
+
|
|
74
|
+
1. Go to ChatGPT → Create GPT → Actions
|
|
75
|
+
2. Import [`openai-action/openapi.yaml`](../openai-action/openapi.yaml)
|
|
76
|
+
3. Your GPT can now query Voidly data
|
|
77
|
+
|
|
78
|
+
### Direct API
|
|
79
|
+
|
|
80
|
+
Public endpoints (no auth):
|
|
81
|
+
- `https://api.voidly.ai/data/censorship-index.json`
|
|
82
|
+
- `https://api.voidly.ai/data/country/{code}`
|
|
83
|
+
- `https://api.voidly.ai/data/methodology`
|
|
84
|
+
|
|
70
85
|
## Data Sources
|
|
71
86
|
|
|
72
87
|
- **Primary**: OONI (Open Observatory of Network Interference)
|
|
73
|
-
- **
|
|
74
|
-
- **Countries Monitored**: 50+
|
|
88
|
+
- **Secondary**: Voidly probe network
|
|
75
89
|
- **License**: CC BY 4.0
|
|
76
90
|
|
|
77
|
-
## API Endpoints Used
|
|
78
|
-
|
|
79
|
-
- `https://censorship.voidly.ai/v1/censorship-index`
|
|
80
|
-
- `https://censorship.voidly.ai/v1/censorship-index/:country`
|
|
81
|
-
- `https://censorship.voidly.ai/v1/censorship-index/incidents`
|
|
82
|
-
|
|
83
91
|
## Development
|
|
84
92
|
|
|
85
93
|
```bash
|
|
86
|
-
# Install dependencies
|
|
87
94
|
npm install
|
|
88
|
-
|
|
89
|
-
# Build
|
|
90
95
|
npm run build
|
|
91
|
-
|
|
92
|
-
# Run in development
|
|
93
96
|
npm run dev
|
|
94
97
|
```
|
|
95
98
|
|
|
96
|
-
##
|
|
99
|
+
## Links
|
|
97
100
|
|
|
98
|
-
|
|
101
|
+
- [Voidly Censorship Index](https://voidly.ai/censorship-index)
|
|
102
|
+
- [npm Package](https://www.npmjs.com/package/@voidly/mcp-server)
|
|
103
|
+
- [OpenAI Action Spec](../openai-action/)
|
|
99
104
|
|
|
100
|
-
##
|
|
105
|
+
## License
|
|
101
106
|
|
|
102
|
-
|
|
103
|
-
- [API Documentation](https://voidly.ai/api-docs)
|
|
104
|
-
- [Hugging Face Dataset](https://huggingface.co/datasets/emperor-mew/global-censorship-index)
|
|
107
|
+
MIT
|
package/package.json
CHANGED