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 网站提供对公共文档的访问。

🚀 飞行愉快！ ✈️