TypeSpec MCP 服务器和生成器

TypeSpec MCP 服务器实现了MCP 规范，使您能够快速构建自己的由TypeSpec驱动的 MCP 服务器。我们还将支持您构建 REST API 和其他由 TypeSpec 支持的协议，尽管这是一项正在进行的工作。

请注意，此项目处于公共预览阶段，在正式发布之前实现可能会有重大变化。

概述

本仓库包含哪些包？

目前该仓库包含以下包：

• mcp-server-typespec - 一个 MCP 服务器，用于协助使用 TypeSpec 开发 MCP 扩展。
• typespec-mcp - 一个 TypeSpec 库，用于描述 MCP 服务器，例如 @tool 装饰器。
• typespec-mcp-server-js - 一个 TypeSpec 生成器，用于生成 MCP 工具的 JavaScript 服务器实现。
• typespec-mcp-http-server-js - 一个 TypeSpec 生成器，用于生成调用远程 REST API 的 JavaScript 服务器实现。

当前支持的工具

TypeSpec MCP 服务器提供以下工具：

• learnTypeSpec - 使用有关如何理解和编写 TypeSpec 的信息初始化模型。
• init - 在当前工作目录中搭建一个新的项目，并带有示例工具实现。
• compile - 运行 tsp 编译以生成生成器资产。
• build - 在当前项目中执行 npm run build。

快速开始

TypeSpec MCP 服务器需要 Node.js 来安装和运行服务器。如果您尚未安装，请按照此处的说明进行操作。

VS Code + GitHub Copilot

TypeSpec MCP 服务器提供了帮助编写 TypeSpec 以生成 MCP 资源实现的功能。它可以单独使用，也可以与 VS Code 中的TypeSpec VS Code 扩展一起使用。

先决条件

1. 安装稳定版或 Insiders 版的 VS Code：
   • 稳定版
   • Insiders 版
2. 安装 GitHub Copilot 和 GitHub Copilot Chat 扩展
3. 安装 Node.js 20 或更高版本
   • 确保 node 和 npm 在您的路径中
4. 在空文件夹中打开 VS Code

安装

一键安装

点击其中一个按钮来安装 VS Code 或 VS Code Insiders 的 TypeSpec MCP 服务器。

安装完 TypeSpec MCP 服务器后，请确保选择 GitHub Copilot Agent 模式并刷新工具列表。要了解更多信息，请访问 VS Code 文档。

手动安装

对于逐步安装，请遵循以下说明：

1. 添加 .vscode/mcp.json：

{
  "servers": {
    "TypeSpec MCP Server": {
      "command": "npx",
      "args": ["-y", "mcp-server-typespec@latest"]
    }
  }
}

测试 TypeSpec MCP 服务器

1. 在 VS Code 中打开 GitHub Copilot 并切换到 Agent 模式
2. 您应该能在工具列表中看到 TypeSpec MCP 服务器
3. 尝试一个提示，告诉代理使用 TypeSpec MCP 服务器，例如 "init" 来搭建一个新的项目。

故障排除

参阅故障排除指南以获取常见问题的帮助和日志记录。

贡献

我们欢迎对 TypeSpec MCP 服务器的贡献！无论是修复错误、添加新功能还是改进文档，您的贡献都是受欢迎的。

请阅读我们的贡献指南以获取更多关于如何贡献的信息。

行为准则

本项目采用了 微软开源行为准则。 如需更多信息，请参阅 行为准则 FAQ 或联系 opencode@microsoft.com 以获取任何额外的问题或评论。