Skip to content

Commit d1c83be

Browse files
committed
Initial commit
0 parents  commit d1c83be

13 files changed

+1189
-0
lines changed

.env.example

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# Flightradar24 API Configuration
2+
FR24_API_KEY=your-api-key-here
3+
# Flightradar24 API URL, shouldn't need to change this
4+
FR24_API_URL=https://fr24api.flightradar24.com
5+
# Server Configuration
6+
PORT=3000

.gitignore

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
.DS_Store
2+
dist/
3+
node_modules/
4+
build/
5+
*.log
6+
.env
7+
.env.local
8+
.env.*.local
9+
10+
# Keep example file
11+
!.env.example

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2024 sunsetcoder
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

README.md

Lines changed: 127 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,127 @@
1+
# Flightradar24 MCP Server 🛩️
2+
3+
A Claude Desktop MCP server that helps you track flights in real-time using Flightradar24 data. Perfect for aviation enthusiasts, travel planners, or anyone curious about flights overhead!
4+
5+
## What Can This Do? ✨
6+
7+
- 🔍 Track any flight in real-time
8+
- ⏰ Get arrival and departure times for specific flights
9+
- 🌉 View the status of flights at an airport
10+
- 🚨 Monitor emergency flights
11+
12+
## Setup Guide 🚀
13+
14+
### 1. Prerequisites
15+
- [Claude Desktop](https://claude.ai/desktop) installed on your computer
16+
- A Flightradar24 API key (get one from [Flightradar24's website](https://www.flightradar24.com/premium))
17+
18+
### 2. Installation
19+
20+
1. Clone this repository somewhere on your computer:
21+
```bash
22+
git clone https://github.com/sunsetcoder/flightradar24-mcp-server.git
23+
```
24+
25+
2. Install dependencies & build the project:
26+
```bash
27+
cd flightradar24-mcp-server
28+
npm install
29+
npm run build
30+
```
31+
32+
### 3. Integration with Claude Desktop
33+
34+
1. Open your Claude Desktop configuration file:
35+
```
36+
# On Mac:
37+
~/Library/Application Support/Claude/claude_desktop_config.json
38+
39+
# On Windows:
40+
%APPDATA%/Claude/claude_desktop_config.json
41+
```
42+
43+
2. Add the following to the `mcpServers` object in your config:
44+
```json
45+
{
46+
"mcpServers": {
47+
"flightradar24-server": {
48+
"command": "node",
49+
"args": [
50+
"/Users/<username>/<FULL_PATH...>/flightradar24-mcp-server/dist/index.js"
51+
],
52+
"env": {
53+
"FR24_API_KEY": "your_api_key_here",
54+
"FR24_API_URL": "https://fr24api.flightradar24.com"
55+
}
56+
}
57+
}
58+
}
59+
```
60+
61+
3. Important Steps:
62+
- Replace `/FULL/PATH/TO/flightradar24-mcp-server` with the actual full path to where you cloned the repository
63+
- Add your Flightradar24 API key in the `env` section
64+
- Make sure to use forward slashes (`/`) in the path, even on Windows
65+
66+
4. Restart Claude Desktop for the changes to take effect
67+
68+
## Environment Setup
69+
70+
1. Copy `.env.example` to `.env`:
71+
```bash
72+
cp .env.example .env
73+
```
74+
75+
2. Update the `.env` file with your actual Flightradar24 API key:
76+
```env
77+
FR24_API_KEY=your_actual_api_key_here
78+
```
79+
80+
Note: Never commit your actual API key to version control. The `.env` file is ignored by git for security reasons.
81+
82+
## Let's Try It Out! 🎮
83+
84+
Once the server is configured, you can ask Claude questions like:
85+
86+
1. "What's the ETA for United Airlines flight UA123?"
87+
2. "Show me all flights currently at SFO"
88+
3. "Are there any emergency flights in the area?"
89+
4. "Show me all international flights arriving at SFO in the next 2 hours"
90+
5. "How many commercial flights are currently over the Pacific Ocean?"
91+
6. "Identify any flights that have declared an emergency in the California region"
92+
93+
Example conversation with Claude:
94+
```
95+
You: What's the status of flight UA123?
96+
Claude: Let me check that for you...
97+
[Claude will use the MCP server to fetch real-time flight information]
98+
```
99+
100+
## Common Questions & Troubleshooting 🤔
101+
102+
### "Claude can't connect to the server"
103+
- Check if the path in `claude_desktop_config.json` is correct
104+
- Make sure you're using the full absolute path
105+
- Verify your API key is correct
106+
- Try restarting Claude Desktop
107+
108+
### "The server isn't responding"
109+
- Make sure your Flightradar24 API key is valid
110+
- Check if the API URL is correct
111+
- Look for any error messages in server logs
112+
```
113+
114+
## Need More Help? 🆘
115+
116+
1. Make sure Claude Desktop is properly installed
117+
2. Verify your Flightradar24 API key is active
118+
3. Check the path in your configuration is absolute and correct
119+
4. Look for error messages in Claude Desktop's logs
120+
121+
## License 📄
122+
123+
MIT - Feel free to use this however you want!
124+
125+
---
126+
127+
Made with ❤️ for aviation enthusiasts

0 commit comments

Comments
 (0)