football-docs 0.5.0 → 0.5.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 +4 -30
- package/data/docs.db +0 -0
- package/package.json +1 -1
- package/providers.json +0 -47
package/README.md
CHANGED
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
# football-docs
|
|
2
2
|
|
|
3
|
-
Searchable football data provider documentation for AI coding agents. Like [Context7](https://context7.com) for football data.
|
|
3
|
+
Searchable football data provider and tooling documentation for AI coding agents. Like [Context7](https://context7.com) for football data.
|
|
4
4
|
|
|
5
|
-
**Who it's for:** Developers and analysts who use AI coding tools (Claude Code, Cursor, VS Code Copilot
|
|
5
|
+
**Who it's for:** Developers and analysts who use AI coding tools (Claude Code, Cursor, VS Code Copilot) to work with football data. Works with any tool that supports MCP.
|
|
6
6
|
|
|
7
|
-
**What it does:** Gives your AI agent a searchable index of documentation for 15 football data providers — event types, qualifier IDs, coordinate systems, API endpoints, data models, identity surfaces, and cross-provider comparisons. Your agent looks up the real docs instead of guessing from training data.
|
|
7
|
+
**What it does:** Gives your AI agent a searchable index of documentation for 15 football data providers and tools — event types, qualifier IDs, coordinate systems, API endpoints, data models, identity surfaces, and cross-provider comparisons for the data providers (StatsBomb, Opta, Wyscout, Impect, SkillCorner, and more), plus the open-source libraries people build with (kloppy, mplsoccer, socceraction, soccerdata, and more). Your agent looks up the real docs instead of guessing from training data.
|
|
8
8
|
|
|
9
9
|
**Why not just let the AI figure it out?** LLMs get football data specifics wrong constantly — Opta qualifier IDs, StatsBomb coordinate ranges, API endpoint URLs, library method signatures. These are mutable facts that change across versions. football-docs gives the agent verified, sourced documentation with provenance tracking so you know where every answer came from.
|
|
10
10
|
|
|
@@ -58,21 +58,6 @@ Add to `.vscode/mcp.json`:
|
|
|
58
58
|
}
|
|
59
59
|
```
|
|
60
60
|
|
|
61
|
-
### Windsurf
|
|
62
|
-
|
|
63
|
-
Add to `~/.codeium/windsurf/mcp_config.json`:
|
|
64
|
-
|
|
65
|
-
```json
|
|
66
|
-
{
|
|
67
|
-
"mcpServers": {
|
|
68
|
-
"football-docs": {
|
|
69
|
-
"command": "npx",
|
|
70
|
-
"args": ["-y", "football-docs"]
|
|
71
|
-
}
|
|
72
|
-
}
|
|
73
|
-
}
|
|
74
|
-
```
|
|
75
|
-
|
|
76
61
|
### Claude Desktop
|
|
77
62
|
|
|
78
63
|
Add to `claude_desktop_config.json`:
|
|
@@ -127,7 +112,7 @@ Add to `claude_desktop_config.json`:
|
|
|
127
112
|
| Soccerdonna | 7 | identity-surfaces |
|
|
128
113
|
| Transfermarkt | 7 | identity-surfaces |
|
|
129
114
|
|
|
130
|
-
**968 searchable chunks** across 15 providers.
|
|
115
|
+
**968 searchable chunks** across 15 providers and tools.
|
|
131
116
|
|
|
132
117
|
## Contributing
|
|
133
118
|
|
|
@@ -139,17 +124,6 @@ Contributions are welcome from everyone. There are three ways to help:
|
|
|
139
124
|
|
|
140
125
|
**You don't need to be an expert.** See **[CONTRIBUTING.md](CONTRIBUTING.md)** for the full guide.
|
|
141
126
|
|
|
142
|
-
### What we especially need
|
|
143
|
-
|
|
144
|
-
| Provider | Priority | Source material to start from |
|
|
145
|
-
|----------|----------|-------------------------------|
|
|
146
|
-
| FPL (Fantasy Premier League) | High | [FPL APIs Explained](https://www.oliverlooney.com/blogs/FPL-APIs-Explained) |
|
|
147
|
-
| API-Football (RapidAPI) | High | [API-Football docs](https://www.api-football.com/documentation-v3) |
|
|
148
|
-
| Football-data.org | Medium | [Football-data.org docs](https://www.football-data.org/documentation/api) |
|
|
149
|
-
| TheSportsDB | Medium | [TheSportsDB API](https://www.thesportsdb.com/api.php) |
|
|
150
|
-
| WhoScored | Medium | Based on Opta F24, community-documented |
|
|
151
|
-
| Sofascore | Medium | Unofficial API, community-documented |
|
|
152
|
-
|
|
153
127
|
## For maintainers
|
|
154
128
|
|
|
155
129
|
### Crawl pipeline
|
package/data/docs.db
CHANGED
|
Binary file
|
package/package.json
CHANGED
package/providers.json
CHANGED
|
@@ -150,33 +150,6 @@
|
|
|
150
150
|
],
|
|
151
151
|
"last_crawled": null
|
|
152
152
|
},
|
|
153
|
-
"api-football": {
|
|
154
|
-
"description": "REST API for football data via RapidAPI (fixtures, standings, players, live scores)",
|
|
155
|
-
"version": "3",
|
|
156
|
-
"package": null,
|
|
157
|
-
"sources": [
|
|
158
|
-
{ "url": "https://www.api-football.com/documentation-v3", "type": "api_docs" }
|
|
159
|
-
],
|
|
160
|
-
"last_crawled": null
|
|
161
|
-
},
|
|
162
|
-
"football-data-org": {
|
|
163
|
-
"description": "REST API for football competition data (v4) — fixtures, standings, teams, players",
|
|
164
|
-
"version": "4",
|
|
165
|
-
"package": null,
|
|
166
|
-
"sources": [
|
|
167
|
-
{ "url": "https://docs.football-data.org/general/v4/index.html", "type": "api_docs" }
|
|
168
|
-
],
|
|
169
|
-
"last_crawled": null
|
|
170
|
-
},
|
|
171
|
-
"fpl": {
|
|
172
|
-
"description": "Fantasy Premier League unofficial API — player stats, fixtures, gameweeks, transfers",
|
|
173
|
-
"version": null,
|
|
174
|
-
"package": null,
|
|
175
|
-
"sources": [
|
|
176
|
-
{ "type": "curated", "note": "Unofficial undocumented API; compiled from community sources" }
|
|
177
|
-
],
|
|
178
|
-
"last_crawled": null
|
|
179
|
-
},
|
|
180
153
|
"floodlight": {
|
|
181
154
|
"description": "Python library for spatial football data analysis (tracking, pitch control, metrics)",
|
|
182
155
|
"version": null,
|
|
@@ -187,26 +160,6 @@
|
|
|
187
160
|
],
|
|
188
161
|
"last_crawled": null
|
|
189
162
|
},
|
|
190
|
-
"thesportsdb-v1": {
|
|
191
|
-
"description": "TheSportsDB v1 API — free tier, search-based endpoints for teams, players, events, livescores",
|
|
192
|
-
"version": "1",
|
|
193
|
-
"package": null,
|
|
194
|
-
"sources": [
|
|
195
|
-
{ "url": "https://www.thesportsdb.com/api/spec/v1/openapi.yaml", "type": "openapi" },
|
|
196
|
-
{ "url": "https://www.thesportsdb.com/documentation", "type": "api_docs" }
|
|
197
|
-
],
|
|
198
|
-
"last_crawled": null
|
|
199
|
-
},
|
|
200
|
-
"thesportsdb-v2": {
|
|
201
|
-
"description": "TheSportsDB v2 API — paid tier, expanded endpoints with schedules, statistics, lookups",
|
|
202
|
-
"version": "2",
|
|
203
|
-
"package": null,
|
|
204
|
-
"sources": [
|
|
205
|
-
{ "url": "https://www.thesportsdb.com/api/spec/v2/openapi.yaml", "type": "openapi" },
|
|
206
|
-
{ "url": "https://www.thesportsdb.com/documentation", "type": "api_docs" }
|
|
207
|
-
],
|
|
208
|
-
"last_crawled": null
|
|
209
|
-
},
|
|
210
163
|
"free-sources": {
|
|
211
164
|
"description": "Free football data sources (FBref, Understat, ClubElo, football-data.co.uk)",
|
|
212
165
|
"version": null,
|