Msfs Sdk MCP

🚀 MSFS SDK MCP Server

MSFS SDK MCP Server 是一個現代化、高性能的 MCP 服務器，可通過自然語言和結構化查詢快速、結構化地訪問微軟飛行模擬器 SDK 文檔，為用戶提供便捷的文檔搜索和內容獲取服務。

🚀 快速開始

項目克隆

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

依賴安裝

npm install

項目構建

npm run build

啟動服務器

npm start

✨ 主要特性

• ⚡️ 可在官方 MSFS SDK 文檔中進行即時文檔搜索。
• 📚 支持多種搜索類別，包括內容、索引、術語表和全類別搜索。
• 🧠 具備自然語言處理能力，可處理如 “Search livery op msfs sdk” 這樣的查詢。
• 📊 搜索結果以結構化形式呈現，包含標題、URL、描述和類別。
• 📄 可從特定文檔頁面檢索詳細內容。
• 🔌 與 AI 助手和工具完全兼容 MCP 協議。
• 💾 採用嵌入式數據，無需外部文件。
• 🛡️ 擁有強大的錯誤處理和日誌記錄功能。

📦 安裝指南

環境要求

• Node.js 18.x 或更高版本
• npm 8.x 或更高版本
• TypeScript 5.x

安裝步驟

1. 克隆倉庫

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

2. 安裝依賴

   npm install
   

3. 構建項目

   npm run build
   

4. 啟動服務器

   npm start
   

💻 使用示例

可用工具

搜索類別

• contents - 📖 主要文檔內容
• index - 📇 文檔索引條目
• glossary - 📚 技術術語和定義
• all - 🌐 跨所有類別搜索（默認：索引）

API 使用示例

搜索文檔

{
  "name": "search_msfs_docs",
  "arguments": {
    "query": "livery",
    "category": "all",
    "limit": 10
  }
}

獲取文檔內容

{
  "name": "get_doc_content",
  "arguments": {
    "url": "https://docs.flightsimulator.com/html/...",
    "section": "overview"
  }
}

搜索 URL 格式

https://docs.flightsimulator.com/html/Introduction/Introduction.htm?rhsearch={query}&agt={category}

參數說明：

• {query} - 🔍 搜索詞（URL 編碼）
• {category} - 🏷️ 可選類別（index, glossary 或為空表示內容）

響應格式

{
  "content": [
    {
      "type": "text",
      "text": "**Title**\n- Category: category\n- URL: url\n- Description: description"
    }
  ]
}

📚 詳細文檔

與 AI 助手集成

此服務器可與兼容 MCP 的 AI 助手配合使用，例如：

• 🤖 Claude Desktop - 官方支持 MCP
• 🌊 Windsurf IDE - 內置 MCP 集成
• 🔧 其他 MCP 客戶端 - 所有兼容 MCP 的工具

配置示例

{
  "mcpServers": {
    "msfs-sdk": {
      "command": "node",
      "args": ["path/to/msfs-sdk-mcp/dist/index.js"]
    }
  }
}

🔧 技術細節

技術棧

• 運行時環境：Node.js 18+
• 編程語言：TypeScript 5.0
• 框架：Model Context Protocol (MCP)
• HTTP 客戶端：node-fetch
• HTML 解析器：Cheerio
• 瀏覽器自動化：Puppeteer（可選）
• 構建工具：TypeScript 編譯器

項目結構

msfs-sdk-mcp/
├── 📄 package.json             # 依賴和腳本
├── 📄 tsconfig.json            # TypeScript 配置
├── 📄 README.md               # 項目文檔
├── 📄 LICENSE                 # MIT 許可證
├── 📂 src/
│   ├── 📄 index.ts            # 🚀 主 MCP 服務器
│   └── 📂 services/
│       ├── 📄 documentationService.ts  # 🔍 搜索邏輯
│       └── 📄 naturalLanguageService.ts # 🧠 NLP 處理
└── 📂 dist/                   # 🏗️ 編譯後的 JavaScript

開發腳本

🤝 貢獻指南

1. 🍴 Fork 此倉庫
2. 🌱 創建功能分支：git checkout -b feature-name
3. ✨ 實現並測試你的更改
4. 📝 提交清晰的提交信息：git commit -am 'Add new feature'
5. 🚀 推送到你的分支：git push origin feature-name
6. 📩 打開 Pull Request

提交規範

• feat: - 新功能
• fix: - 修復 bug
• docs: - 文檔更新
• refactor: - 代碼重構
• test: - 添加測試

📄 許可證

本項目採用 MIT 許可證，詳情請參閱 LICENSE 文件。

📞 支持與聯繫

• 🐛 問題反饋：GitHub Issues
• 📚 MSFS SDK 文檔：官方文檔
• ❓ 新問題：請提供清晰的信息和可復現的步驟

📅 更新日誌

v1.0.0 - 🎉 初始版本

• ✨ 初始發佈 - 完整的 MCP 服務器實現
• 🔍 即時文檔搜索 - 快速訪問 MSFS SDK 文檔
• 📚 多搜索類別 - 支持內容、索引和術語表搜索
• 🧠 自然語言處理 - 直觀的查詢處理
• 🔌 支持 MCP 標準 - 完全兼容
• 💾 嵌入式數據 - 無需外部依賴

⚠️ 免責聲明

這是一個非官方工具，與微軟或微軟飛行模擬器沒有關聯。該工具通過官方 MSFS SDK 網站提供對公共文檔的訪問。

🚀 飛行愉快！ ✈️