What is Typespec Mcp

The TypeSpec MCP Server is an implementation of the Model Context Protocol (MCP), designed to help developers build their own MCP servers using TypeSpec. It supports building various protocols, including REST APIs, although this functionality is still in development. The project is currently available in Public Preview, with potential for significant changes before general availability.

Use cases

The TypeSpec MCP Server can be used to scaffold new projects, generate MCP resource implementations, and facilitate the development of TypeSpec-based tools and extensions. It provides a structured way to develop APIs and other functionalities under the MCP specification, making it suitable for developers looking to enhance their server capabilities with TypeSpec.

How to use

To use the TypeSpec MCP Server, developers need to install it via NPX in Visual Studio Code. After installation, they can initialize a project using the ‘init’ command, generate emitter assets with ‘compile’, and build the project with ‘build’. It is also recommended to use it alongside the GitHub Copilot extension for enhanced assistance in authoring TypeSpec.

Key features

Key features of the TypeSpec MCP Server include tools for initializing projects, compiling TypeSpec code, and building server implementations. Additionally, it offers integration with GitHub Copilot for streamlined coding assistance and supports various scripting options for developing and scaffolding applications based on the MCP specification.

Where to use

The TypeSpec MCP Server is intended for use in development environments where TypeSpec is employed to create and manage APIs and other server implementations. It is particularly useful in project setup and prototyping phases within Visual Studio Code, making it suitable for developers working on TypeSpec-based technologies.

TypeSpec MCP Server and Emitter

The TypeSpec MCP Server implements the MCP specification to enable you to quickly build out your own MCP servers powered by TypeSpec. We will also enable you to build REST APIs and other protocols supported by TypeSpec, though this is work in progress.

Please note that this project is in Public Preview and implementation may significantly change prior to our General Availability.

Overview

What packages are in this repository?

Currently this repo contains the following packages:

• mcp-server-typespec - an MCP server which assists in developing MCP extensions using TypeSpec.
• typespec-mcp - a TypeSpec library for describing MCP servers, for example the @tool decorator.
• typespec-mcp-server-js - A TypeSpec emitter that generates a server implementation in JavaScript for an MCP tool.
• typespec-mcp-http-server-js - A TypeSpec emitter that generates a server implementation in JavaScript for calling a remote REST API.

Currently Supported Tools

The TypeSpec MCP Server provides the following tools:

• learnTypeSpec - Initializes the model with information about how to understand and write TypeSpec.
• init - Scaffolds out a new project in the current working directory with example tool implementation.
• compile - Runs tsp compile to generate emitter assets
• build - Executes npm run build in the current project.

Getting Started

The TypeSpec MCP Server requires Node.js to install and run the server. If you don’t have it installed, follow the instructions here.

VS Code + GitHub Copilot

The TypeSpec MCP Server provides assistance with authoring TypeSpec to generate MCP resource implementations. It can be used alone or with the TypeSpec VS Code extension in VS Code.

Prerequisites

1. Install either the stable or Insiders release of VS Code:
   • Stable release
   • Insiders release
2. Install the GitHub Copilot and GitHub Copilot Chat extensions
3. Install Node.js 20 or later
   • Ensure node and npm are in your path
4. Open VS Code in an empty folder

Installation

One-Click Install

Click one of these buttons to install the TypeSpec MCP Server for VS Code or VS Code Insiders.

Once you’ve installed the TypeSpec MCP Server, make sure you select GitHub Copilot Agent Mode and refresh the tools list. To learn more about Agent Mode, visit the VS Code Documentation.

Manual Install

For a step-by-step installation, follow these instructions:

1. Add .vscode/mcp.json:

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

Test the TypeSpec MCP Server

1. Open GitHub Copilot in VS Code and switch to Agent mode
2. You should see the TypeCpec MCP Server in the list of tools
3. Try a prompt that tells the agent to use a TypeSpec MCP Server, such as “init” to scaffold a new project.

Troubleshooting

See Troubleshooting guide for help with common issues and logging.

Contributing

We welcome contributions to the TypeSpec MCP Server! Whether you’re fixing bugs, adding new features, or improving documentation, your contributions are welcome.

Please read our Contributing Guide for more information on how to contribute.

Code of Conduct

This project has adopted the
Microsoft Open Source Code of Conduct.
For more information, see the
Code of Conduct FAQ
or contact [email protected]
with any additional questions or comments.