Msfs Sdk MCP

🚀 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: Conduct real-time searches within the official MSFS SDK documentation.
• 📚 Multiple search categories: Offers various search categories including contents, index, glossary, and all.
• 🧠 Natural language processing: Supports natural language queries such as "Search livery op msfs sdk".
• 📊 Structured results: Provides structured results with titles, URLs, descriptions, and categories.
• 📄 Detailed content retrieval: Retrieve detailed content from specific documentation pages.
• 🔌 Full MCP compatibility: Fully compatible with AI assistants and tools that support MCP.
• 💾 Embedded data: No need for external files as data is embedded.
• 🛡️ Robust error handling and logging: Ensures reliable operation with robust error handling and logging mechanisms.

📦 Installation

📋 Requirements

• Node.js 18.x or higher
• npm 8.x or higher
• TypeScript 5.x

🚀 Setup

1. Clone the repository:

   git clone https://github.com/yourusername/msfs-sdk-mcp.git
   cd msfs-sdk-mcp
   

2. Install dependencies:

   npm install
   

3. Build the project:

   npm run build
   

4. Start the server:

   npm start
   

🔧 Technical Details

🛠️ Tech Stack

💻 Usage Examples

🔧 Available Tools

🏷️ 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

{
  "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

📚 Documentation

📈 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

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 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: Supports contents, index, and glossary.
• 🧠 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. It provides access to public documentation via the official MSFS SDK website.

🚀 Happy Flying! ✈️