# MSFS SDK MCP Server
[](https://nodejs.org/)
[](https://www.typescriptlang.org/)
[](https://modelcontextprotocol.io/)
[](LICENSE)
[](https://github.com)
A modern, performant MCP server for fast, structured access to Microsoft Flight Simulator SDK documentation via natural language and structured queries.
## ๐ Features
- โก๏ธ **Real-time documentation search** in the official MSFS SDK documentation
- ๐ **Multiple search categories**: contents, index, glossary, all
- ๐ง **Natural language processing**: queries like "Search livery op msfs sdk"
- ๐ **Structured results**: titles, URLs, descriptions, categories
- ๐ **Detailed content retrieval** from specific documentation pages
- ๐ **Full MCP compatibility** with AI assistants and tools
- ๐พ **Embedded data**: no external files needed
- ๐ก๏ธ **Robust error handling** and logging
## ๐ ๏ธ Tech Stack
- **Runtime:** Node.js 18+
- **Language:** TypeScript 5.0
- **Framework:** Model Context Protocol (MCP)
- **HTTP Client:** node-fetch
- **HTML Parser:** Cheerio
- **Browser Automation:** Puppeteer (optional)
- **Build Tool:** TypeScript Compiler
## ๐ Requirements
- Node.js 18.x or higher
- npm 8.x or higher
- TypeScript 5.x
## ๐ Setup
1. **Clone the repository:**
```bash
git clone https://github.com/yourusername/msfs-sdk-mcp.git
cd msfs-sdk-mcp
```
2. **Install dependencies:**
```bash
npm install
```
3. **Build the project:**
```bash
npm run build
```
4. **Start the server:**
```bash
npm start
```
## ๐ง Available Tools
| Tool | Description | Parameters |
|------|-------------|------------|
| `search_msfs_docs` | ๐ Search MSFS SDK documentation | `query`, `category`, `limit` |
| `get_doc_content` | ๐ Retrieve detailed content | `url`, `section` |
| `list_categories` | ๐ Show all search categories | - |
| `list_category_items` | ๐ List items per category | `category` |
| `natural_language_query` | ๐ง Natural language queries | `query` |
### ๐ท๏ธ Search Categories
- `contents` - ๐ Main documentation content
- `index` - ๐ Documentation index entries
- `glossary` - ๐ Technical terms and definitions
- `all` - ๐ Search across all categories (default: index)
## ๐ Integration with AI Assistants
This server works with MCP-compatible AI assistants such as:
- ๐ค **Claude Desktop** - Official MCP support
- ๐ **Windsurf IDE** - Built-in MCP integration
- ๐ง **Other MCP clients** - All MCP-compatible tools
### โ๏ธ Configuration Example
```json
{
"mcpServers": {
"msfs-sdk": {
"command": "node",
"args": ["path/to/msfs-sdk-mcp/dist/index.js"]
}
}
}
```
## ๐ Project Structure
```plaintext
msfs-sdk-mcp/
โโโ ๐ package.json # Dependencies and scripts
โโโ ๐ tsconfig.json # TypeScript configuration
โโโ ๐ README.md # Project documentation
โโโ ๐ LICENSE # MIT License
โโโ ๐ src/
โ โโโ ๐ index.ts # ๐ Main MCP server
โ โโโ ๐ services/
โ โโโ ๐ documentationService.ts # ๐ Search logic
โ โโโ ๐ naturalLanguageService.ts # ๐ง NLP processing
โโโ ๐ dist/ # ๐๏ธ Compiled JavaScript
```
## ๐งช Development & Scripts
| Script | Description | Command |
|--------|-------------|----------|
| ๐๏ธ **Build** | Compile TypeScript | `npm run build` |
| ๐ **Dev** | Watch mode development | `npm run dev` |
| ๐ **Start** | Start MCP server | `npm start` |
| ๐ **Type Check** | TypeScript validation | `npx tsc --noEmit` |
## ๐ API Reference
### ๐ Tool Examples
#### ๐ search_msfs_docs
```json
{
"name": "search_msfs_docs",
"arguments": {
"query": "livery",
"category": "all",
"limit": 10
}
}
```
#### ๐ list_category_items
```json
{
"name": "list_category_items",
"arguments": {
"category": "glossary"
}
}
```
#### ๐ get_doc_content
```json
{
"name": "get_doc_content",
"arguments": {
"url": "https://docs.flightsimulator.com/html/...",
"section": "overview"
}
}
```
### ๐ Search URL Format
```plaintext
https://docs.flightsimulator.com/html/Introduction/Introduction.htm?rhsearch={query}&agt={category}
```
**Parameters:**
- `{query}` - ๐ Search term (URL-encoded)
- `{category}` - ๐ท๏ธ Optional category (`index`, `glossary`, or empty for contents)
### ๐ Response Format
```json
{
"content": [
{
"type": "text",
"text": "**Title**\n- Category: category\n- URL: url\n- Description: description"
}
]
}
```
## ๐ค Contributing
1. ๐ด **Fork** this repository
2. ๐ฑ **Create** a feature branch: `git checkout -b feature-name`
3. โจ **Implement** and test your changes
4. ๐ **Commit** with clear message: `git commit -am 'Add new feature'`
5. ๐ **Push** to your branch: `git push origin feature-name`
6. ๐ฉ **Open** a Pull Request
### ๐
Commit Convention
- `feat:` - New features
- `fix:` - Bug fixes
- `docs:` - Documentation updates
- `refactor:` - Code refactoring
- `test:` - Test additions
## ๐ License
**MIT License** โ See [LICENSE](./LICENSE) file for details.
## ๐ Support & Contact
- ๐ **Issues**: [GitHub Issues](https://github.com/yourusername/msfs-sdk-mcp/issues)
- ๐ **MSFS SDK Docs**: [Official documentation](https://docs.flightsimulator.com)
- โ **New issue?** Provide clear information and reproducible steps
## ๐
Changelog
### v1.0.0 - ๐ Initial Release
- โจ **Initial release** - Complete MCP server implementation
- ๐ **Real-time documentation search** - Fast access to MSFS SDK docs
- ๐ **Multiple search categories** - Contents, index, glossary support
- ๐ง **Natural language processing** - Intuitive query processing
- ๐ **MCP standard support** - Full compatibility
- ๐พ **Embedded data** - No external dependencies
---
## โ ๏ธ Disclaimer
**This is an unofficial tool**, not affiliated with Microsoft or Microsoft Flight Simulator.
Provides access to public documentation via the official MSFS SDK website.
๐ **Happy Flying!** โ๏ธ
---
[](https://github.com/90barricade93/MSFS-SDK-MCP/fork)
ยฉ 90barricade93 - aero-ai-solutions.com
[](https://github.com/90barricade93/MSFS-SDK-MCP)