MSFS SDK MCP Server
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
-
Clone the repository:
git clone https://github.com/yourusername/msfs-sdk-mcp.git cd msfs-sdk-mcp -
Install dependencies:
npm install -
Build the project:
npm run build -
Start the server:
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 contentindex- 📇 Documentation index entriesglossary- 📚 Technical terms and definitionsall- 🌐 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
{
"mcpServers": {
"msfs-sdk": {
"command": "node",
"args": ["path/to/msfs-sdk-mcp/dist/index.js"]
}
}
}
📁 Project Structure
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
{
"name": "search_msfs_docs",
"arguments": {
"query": "livery",
"category": "all",
"limit": 10
}
}
📋 list_category_items
{
"name": "list_category_items",
"arguments": {
"category": "glossary"
}
}
📄 get_doc_content
{
"name": "get_doc_content",
"arguments": {
"url": "https://docs.flightsimulator.com/html/...",
"section": "overview"
}
}
🌐 Search URL Format
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
{
"content": [
{
"type": "text",
"text": "**Title**\n- Category: category\n- URL: url\n- Description: description"
}
]
}
🤝 Contributing
- 🍴 Fork this repository
- 🌱 Create a feature branch:
git checkout -b feature-name - ✨ Implement and test your changes
- 📝 Commit with clear message:
git commit -am 'Add new feature' - 🚀 Push to your branch:
git push origin feature-name - 📩 Open a Pull Request
📅 Commit Convention
feat:- New featuresfix:- Bug fixesdocs:- Documentation updatesrefactor:- Code refactoringtest:- Test additions
📄 License
MIT License – See LICENSE file for details.
📞 Support & Contact
- 🐛 Issues: GitHub Issues
- 📚 MSFS SDK Docs: Official documentation
- ❓ 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! ✈️
