TypeSpec MCP Server and Emitter

TypeSpec MCP 服务和生成器

TypeSpec MCP 服务实现了 MCP 规范，让你能够快速构建由 TypeSpec 驱动的自有 MCP 服务。我们还将支持你构建 REST API 和 TypeSpec 支持的其他协议，不过这项工作仍在进行中。

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

概览

此仓库包含哪些软件包？

目前，此仓库包含以下软件包：

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

当前支持的工具

TypeSpec MCP 服务提供以下工具：

• learnTypeSpec - 向模型提供有关如何理解和编写 TypeSpec 的信息。
• init - 在当前工作目录中搭建一个新项目，并包含示例工具实现。
• compile - 运行 tsp compile 以生成生成器资源
• build - 在当前项目中执行 npm run build。

入门

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

VS Code + GitHub Copilot

TypeSpec MCP 服务可协助编写 TypeSpec，以生成 MCP 资源实现。它可以单独使用，也可以与 VS Code 中的 TypeSpec VS Code 扩展搭配使用。

先决条件

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

安装

一键安装

点击以下任一按钮，即可为 VS Code 或 VS Code Insiders 安装 TypeSpec MCP Server。

安装 TypeSpec MCP Server 后，请确保选择 GitHub Copilot Agent Mode 并刷新工具列表。若要了解 Agent Mode，请访问 VS Code 文档。

手动安装

请按照以下说明逐步安装：

1. 添加 .vscode/mcp.json：

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

测试 TypeSpec MCP Server

1. 在 VS Code 中打开 GitHub Copilot，并切换到 Agent 模式
2. 你应该会在工具列表中看到 TypeCpec MCP Server
3. 尝试输入一条提示词，告知 Agent 使用 TypeSpec MCP Server，例如输入“init”以搭建新项目的脚手架。

故障排除

如需解决常见问题并查看日志，请参阅故障排除指南。

贡献

欢迎为 TypeSpec MCP Server 做出贡献！无论是修复错误、添加新功能，还是改进文档，我们都欢迎你的贡献。

请阅读我们的贡献指南，了解如何参与贡献。

行为准则

本项目采用了 Microsoft 开源行为准则。 如需了解更多信息，请查看 行为准则常见问题 或通过 [email protected] 联系他们，提出其他问题或意见。