使用说明

MSFS SDK MCP服务器

一个现代化、高性能的MCP服务器，用于通过自然语言和结构化查询快速、结构化地访问Microsoft Flight Simulator SDK文档。

🚀 特性

⚡️ 实时文档搜索 在MSFS SDK官方文档中
📚 多个搜索类别：内容、索引、术语表、全部
🧠 自然语言处理：像“搜索livery op msfs sdk”这样的查询
📊 结构化结果：标题、URL、描述、类别
📄 详细内容检索 来自特定文档页面
🔌 完全兼容MCP 使用人工智能助手和工具
💾 嵌入数据：不需要外部文件
🛡️ 稳健的错误处理 以及日志记录

🛠️ 技术栈

运行时间： Node.js 18+
语言： TypeScript 5.0
框架： 模型上下文协议（MCP）
HTTP客户端： 节点获取
HTML解析器： 再见
浏览器自动化： 木偶（可选）
构建工具： TypeScript编译器

📋 需求

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

🚀 设置

克隆存储库：

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

安装依赖项：
```
npm install
```
构建项目：
```
npm run build
```
启动服务器：
```
npm start
```

🔧 可用工具

工具	说明	参数
`search_msfs_docs`	🔍 搜索MSFS SDK文档	`query`, `category`, `limit`
`get_doc_content`	📄 检索详细内容	`url`, `section`
`list_categories`	📚 显示所有搜索类别	-
`list_category_items`	📋 按类别列出项目	`category`
`natural_language_query`	🧠 自然语言查询	`query`

🏷️ 搜索类别

contents - 📖 主要文件内容
index - 📇 文档索引条目
glossary - 📚 术语和定义
all - 🌐 在所有类别中搜索（默认：索引）

🔌 与AI助手集成

此服务器与MCP兼容的AI助手配合使用，例如：

🤖 克劳德桌面 -MCP官方支持
🌊 Windsurf IDE -内置MCP集成
🔧 其他MCP客户端 -所有MCP兼容工具

⚙️ 配置示例

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

📁 项目结构

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

🧪 开发和脚本

脚本	描述	命令
🏗️ 构建	编译TypeScript	`npm run build`
👀 开发	手表模式开发	`npm run dev`
🚀 开始	启动MCP服务器	`npm start`
🔍 类型检查	TypeScript验证	`npx tsc --noEmit`

📚 api参考

📈 工具示例

🔍 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"
  }
}

🌐 搜索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"
    }
  ]
}

🤝 贡献

🍴 分叉此存储库
🌱 创建特征分支： git checkout -b feature-name
✨ 实施并测试您的更改
📝 提交信息明确： git commit -am 'Add new feature'
🚀 推到您的分行： git push origin feature-name
📩 打开拉取请求

📅 承诺公约

feat: -新功能
fix: -Bug修复
docs: -文档更新
refactor: -代码重构
test: -测试添加

📄 许可证

MIT许可证 –参见许可证文件以获取详细信息。

📞 支持与联系

🐛 问题: GitHub问题
📚 MSFS SDK文档: 正式文件
❓ 新问题？ 提供清晰的信息和可重复的步骤

📅 更新日志

v1.0.0-🎉 初始版本

✨ 初始版本 -完成MCP服务器的实施
🔍 实时文档搜索 -快速访问MSFS SDK文档
📚 多个搜索类别 -目录、索引、术语表支持
🧠 自然语言处理 -直观的查询处理
🔌 MCP标准支持 -完全兼容
💾 嵌入数据 -无外部依赖关系

⚠️ 免责声明

这是一个非官方工具，与微软或微软飞行模拟器无关。通过MSFS SDK官方网站提供对公共文档的访问。

🚀 快乐飞翔！ ✈️