@withinfocus/tba-mcp-server 1.0.4 → 1.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.
Files changed (3) hide show
  1. package/README.md +49 -39
  2. package/dist/index.js +1 -1
  3. package/package.json +1 -1
package/README.md CHANGED
@@ -11,31 +11,35 @@ A Model Context Protocol (MCP) server that provides access to The Blue Alliance
11
11
  - **Type Safety**: All responses validated with Zod schemas
12
12
  - **Comprehensive Coverage**: 35+ tools covering all major TBA API endpoints
13
13
 
14
- ## Prerequisites
15
-
16
- - Node.js 24
17
- - [The Blue Alliance](https://www.thebluealliance.com/) API key
18
-
19
14
  ## Installation
20
15
 
21
- ### From npm
16
+ ### npm (Recommended)
22
17
 
23
18
  ```bash
24
19
  npm install -g @withinfocus/tba-mcp-server
25
20
  ```
26
21
 
27
- ### From source
22
+ ### Docker
23
+
24
+ Pull the image from GitHub Container Registry:
25
+
26
+ ```bash
27
+ docker pull ghcr.io/withinfocus/tba-mcp-server:latest
28
+ ```
29
+
30
+ Or build locally:
28
31
 
29
32
  ```bash
30
33
  git clone https://github.com/withinfocus/tba-mcp-server.git
31
34
  cd tba-mcp-server
32
- npm ci
33
- npm run build
35
+ docker build -t tba-mcp-server .
34
36
  ```
35
37
 
36
38
  ## Configuration
37
39
 
38
- Set your The Blue Alliance API key as an environment variable:
40
+ 1. Get an API key from [The Blue Alliance](https://www.thebluealliance.com/account)
41
+
42
+ 2. Set your API key as an environment variable:
39
43
 
40
44
  ```bash
41
45
  export TBA_API_KEY=your_api_key_here
@@ -49,6 +53,8 @@ TBA_API_KEY=your_api_key_here
49
53
 
50
54
  ## Usage
51
55
 
56
+ ### With npm
57
+
52
58
  Add to your MCP client configuration (e.g., Claude Desktop):
53
59
 
54
60
  ```json
@@ -65,6 +71,37 @@ Add to your MCP client configuration (e.g., Claude Desktop):
65
71
  }
66
72
  ```
67
73
 
74
+ ### With Docker
75
+
76
+ Add to your MCP client configuration:
77
+
78
+ ```json
79
+ {
80
+ "mcpServers": {
81
+ "tba": {
82
+ "command": "docker",
83
+ "args": [
84
+ "run",
85
+ "--rm",
86
+ "-i",
87
+ "--init",
88
+ "-e",
89
+ "TBA_API_KEY=your_api_key_here",
90
+ "ghcr.io/withinfocus/tba-mcp-server:latest"
91
+ ]
92
+ }
93
+ }
94
+ }
95
+ ```
96
+
97
+ Or run directly:
98
+
99
+ ```bash
100
+ docker run --rm -i --init \
101
+ -e TBA_API_KEY=your_api_key_here \
102
+ ghcr.io/withinfocus/tba-mcp-server:latest
103
+ ```
104
+
68
105
  ## Available Tools
69
106
 
70
107
  ### Team Information (24 tools)
@@ -73,45 +110,34 @@ Access comprehensive team data including profiles, participation history, events
73
110
 
74
111
  **Key tools**: `get_team`, `get_team_events`, `get_team_matches`, `get_team_awards`, `get_team_media`
75
112
 
76
- [View all team tools →](docs/TOOLS.md#team-information-tools)
77
-
78
113
  ### Event Information (19 tools)
79
114
 
80
115
  Query event details, participants, rankings, matches, and analytics.
81
116
 
82
117
  **Key tools**: `get_event`, `get_events`, `get_event_teams`, `get_event_rankings`, `get_event_matches`, `get_event_oprs`
83
118
 
84
- [View all event tools →](docs/TOOLS.md#event-information-tools)
85
-
86
119
  ### Match Information (3 tools)
87
120
 
88
121
  Retrieve detailed match data including scores, alliances, and robot tracking.
89
122
 
90
123
  **Key tools**: `get_match`, `get_match_simple`, `get_match_zebra`
91
124
 
92
- [View all match tools →](docs/TOOLS.md#match-information-tools)
93
-
94
125
  ### District Tools (8 tools)
95
126
 
96
127
  Access district rankings, events, and team information.
97
128
 
98
129
  **Key tools**: `get_districts`, `get_district_rankings`, `get_district_events`, `get_district_teams`
99
130
 
100
- [View all district tools →](docs/TOOLS.md#district-tools)
101
-
102
131
  ### General/Utility Tools (6 tools)
103
132
 
104
133
  Paginated team listings and API status information.
105
134
 
106
135
  **Key tools**: `get_teams`, `get_teams_by_year`, `get_status`
107
136
 
108
- [View all utility tools →](docs/TOOLS.md#generalutility-tools)
109
-
110
137
  ### Complete Documentation
111
138
 
112
139
  - **[All Tools](docs/TOOLS.md)** - Complete reference for all 35+ tools with parameters and examples
113
140
  - **[Data Schemas](docs/SCHEMAS.md)** - Detailed schema documentation for all response types
114
- - **[Development Guide](docs/DEVELOPMENT.md)** - Building, testing, and contributing
115
141
 
116
142
  ## Quick Examples
117
143
 
@@ -154,25 +180,9 @@ get_match(match_key: "2024casj_qm1")
154
180
  get_match_zebra(match_key: "2024casj_qm1")
155
181
  ```
156
182
 
157
- ## Development
158
-
159
- See the [Development Guide](docs/DEVELOPMENT.md) for detailed instructions on:
183
+ ## Contributing
160
184
 
161
- - Building and testing
162
- - Adding new tools
163
- - Running unit and integration tests
164
- - Code standards and contribution guidelines
165
-
166
- Quick start:
167
-
168
- ```bash
169
- npm ci # Install dependencies
170
- npm run build # Build TypeScript
171
- npm test # Run unit tests
172
- npm run test:integration # Run integration tests
173
- npm run lint # Check code quality
174
- npm run inspect # Launch MCP inspector
175
- ```
185
+ Contributions are welcome! See [CONTRIBUTING.md](CONTRIBUTING.md) for development setup, testing guidelines, and how to add new tools.
176
186
 
177
187
  ## Related Links
178
188
 
package/dist/index.js CHANGED
@@ -20,7 +20,7 @@ async function runServer() {
20
20
  }
21
21
  server = new Server({
22
22
  name: 'The Blue Alliance MCP Server',
23
- version: '1.0.4',
23
+ version: '1.1.0',
24
24
  }, {
25
25
  capabilities: {
26
26
  tools: {},
package/package.json CHANGED
@@ -2,7 +2,7 @@
2
2
  "type": "module",
3
3
  "name": "@withinfocus/tba-mcp-server",
4
4
  "mcpName": "io.github.withinfocus/tba",
5
- "version": "1.0.4",
5
+ "version": "1.1.0",
6
6
  "description": "The Blue Alliance MCP Server",
7
7
  "repository": {
8
8
  "type": "git",