Model Context Protocol

https://modelcontextprotocol.org
Admin
Model Context Protocol is an open-source standard that enables AI applications to connect seamlessly...
Tokens:546,501
Snippets:4,126
Trust Score:8.7
Update:5 days ago
Show doc for...
Tokens:
Raw
### mcpdo quickstart commands

Source: https://modelcontextprotocol.org/docs/2026-07-28/tools/inspector/mcpdo

Example commands for listing catalog entries, connecting to a server, invoking tools, reading resources, listing connections, and disconnecting. The @my-server prefix targets a named connection.

```bash
mcpdo servers/list                            # catalog entries you can connect
mcpdo connect my-server                       # connect a catalog entry
mcpdo @my-server tools/list
mcpdo @my-server tools/call echo message:=hi
mcpdo @my-server resources/read file:///tmp/notes.txt
mcpdo connections/list                        # what's open
mcpdo disconnect my-server
```

--------------------------------

### Example: Get prompt request

Source: https://modelcontextprotocol.org/specification/2026-07-28/schema

Example JSON-RPC request for the prompts/get method, requesting a code_review prompt with a code argument.

```json
{  
  “jsonrpc”: “2.0”,  
  “id”: “get-prompt-example”,  
  “method”: “prompts/get”,  
  “params”: {  
    “_meta”: {  
      “io.modelcontextprotocol/protocolVersion”: “2026-07-28”,  
      “io.modelcontextprotocol/clientInfo”: {  
        “name”: “ExampleClient”,  
        “version”: “1.0.0”  
      },  
      “io.modelcontextprotocol/clientCapabilities”: {}  
    },  
    “name”: “code_review”,  
    “arguments”: {  
      “code”: “def hello():\n    print(‘world’)”  
    }  
  }  
}
```

--------------------------------

### Set up Go project (Windows)

Source: https://modelcontextprotocol.org/docs/2026-07-28/develop/build-server

Creates a new directory, initializes a Go module, installs the MCP SDK dependency, and creates the main.go file on Windows.

```powershell
# Create a new directory for our project
md weather
cd weather

# Initialize Go module
go mod init weather

# Install dependencies
go get github.com/modelcontextprotocol/go-sdk/mcp

# Create our server file
new-item main.go

```

--------------------------------

### Build and serve the app (Windows)

Source: https://modelcontextprotocol.org/extensions/apps/build

Build the UI and start the local server on Windows.

```bash
npm run build; npm run serve

```

--------------------------------

### Example: Get prompt result response

Source: https://modelcontextprotocol.org/specification/2026-07-28/schema

Example JSON-RPC response containing a complete prompt result with a code review message.

```json
{  
  “jsonrpc”: “2.0”,  
  “id”: “get-prompt-example”,  
  “result”: {  
    “resultType”: “complete”,  
    “description”: “Code review prompt”,  
    “messages”: [  
      {  
        “role”: “user”,  
        “content”: {  
          “type”: “text”,  
          “text”: “Please review this Python code:\ndef hello():\n    print(‘world’)”  
        }  
      }  
    ]  
  }  
}
```

--------------------------------

### Example: Get code review prompt

Source: https://modelcontextprotocol.org/specification/2026-07-28/schema

Example params object for a prompts/get request, requesting the code_review prompt with a code argument.

```json
{  
  “_meta”: {  
    “io.modelcontextprotocol/protocolVersion”: “2026-07-28”,  
    “io.modelcontextprotocol/clientInfo”: {  
      “name”: “ExampleClient”,  
      “version”: “1.0.0”  
    },  
    “io.modelcontextprotocol/clientCapabilities”: {}  
  },  
  “name”: “code_review”,  
  “arguments”: {  
    “code”: “def hello():\n    print(‘world’)”  
  }  
}
```

--------------------------------

### Set up Go project (macOS/Linux)

Source: https://modelcontextprotocol.org/docs/2026-07-28/develop/build-server

Creates a new directory, initializes a Go module, installs the MCP SDK dependency, and creates the main.go file on macOS/Linux.

```bash
# Create a new directory for our project
mkdir weather
cd weather

# Initialize Go module
go mod init weather

# Install dependencies
go get github.com/modelcontextprotocol/go-sdk/mcp

# Create our server file
touch main.go

```

--------------------------------

### Clone and set up the weather-server-typescript sample

Source: https://modelcontextprotocol.org/registry/quickstart

Commands to clone the quickstart-resources repository and copy the weather-server-typescript server into your current directory, then clean up and navigate into the project.

```bash
git clone --depth 1 git@github.com:modelcontextprotocol/quickstart-resources.git
cp -r quickstart-resources/weather-server-typescript .
rm -rf quickstart-resources
cd weather-server-typescript

```

--------------------------------

### Support remote and non-remote installation in server.json

Source: https://modelcontextprotocol.org/registry/remote-servers

Shows how to combine `remotes` and `packages` properties in server.json to allow MCP host applications to choose between remote and local installation. The example includes a streamable-http remote and an npm package with stdio transport.

```json
{
  "$schema": "https://static.modelcontextprotocol.io/schemas/2025-12-11/server.schema.json",
  "name": "io.github.username/email-integration-mcp",
  "title": "Email Integration",
  "description": "Send emails and manage email accounts",
  "version": "1.0.0",
  "remotes": [
    {
      "type": "streamable-http",
      "url": "https://email.example.com/mcp"
    }
  ],
  "packages": [
    {
      "registryType": "npm",
      "identifier": "@example/email-integration-mcp",
      "version": "1.0.0",
      "transport": {
        "type": "stdio"
      }
    }
  ]
}
```

--------------------------------

### server.json for Cargo package

Source: https://modelcontextprotocol.org/registry/package-types

Example server.json for a Cargo package using registryType 'cargo'. It omits runtimeHint because cargo install places the binary on PATH and clients invoke it by name.

```json
{
  "$schema": "https://static.modelcontextprotocol.io/schemas/2025-12-11/server.schema.json",
  "name": "io.github.username/widget-mcp",
  "title": "Widget",
  "description": "Rust-native MCP server",
  "version": "0.3.0",
  "packages": [
    {
      "registryType": "cargo",
      "identifier": "widget-mcp",
      "version": "0.3.0",
      "transport": {
        "type": "stdio"
      }
    }
  ]
}
```

--------------------------------

### Create a new .NET console project

Source: https://modelcontextprotocol.org/docs/2026-07-28/develop/build-client

Initializes a new console project named QuickstartClient and changes into its directory.

```bash
dotnet new console -n QuickstartClient
cd QuickstartClient

```

--------------------------------

### Clone and build Inspector test servers

Source: https://modelcontextprotocol.org/docs/2026-07-28/tools/inspector/protocol-eras

Clones the Inspector repository, installs dependencies, builds the project, and builds the test servers. Run from a terminal before starting any composable server.

```bash
git clone https://github.com/modelcontextprotocol/inspector
cd inspector && npm install && npm run build
cd clients/web && npm run test-servers:build && cd ../..

```

--------------------------------

### Example prompt definition: plan-vacation

Source: https://modelcontextprotocol.org/docs/2026-07-28/learn/server-concepts

JSON definition of a prompt named 'plan-vacation' with arguments for destination, duration, budget, and interests. Used to guide users through vacation planning with structured input.

```json
{
  "name": "plan-vacation",
  "title": "Plan a vacation",
  "description": "Guide through vacation planning process",
  "arguments": [
    { "name": "destination", "type": "string", "required": true },
    { "name": "duration", "type": "number", "description": "days" },
    { "name": "budget", "type": "number", "required": false },
    { "name": "interests", "type": "array", "items": { "type": "string" } }
  ]
}
```

--------------------------------

### Set up Ruby project (Windows)

Source: https://modelcontextprotocol.org/docs/2026-07-28/develop/build-server

Commands to create a new directory, initialize a Gemfile, add the MCP SDK dependency, and create the server file on Windows.

```powershell
# Create a new directory for our project
mkdir weather
cd weather

# Create a Gemfile
bundle init

# Add the MCP SDK dependency
bundle add mcp

# Create our server file
new-item weather.rb

```

--------------------------------

### Build and serve the app (macOS/Linux)

Source: https://modelcontextprotocol.org/extensions/apps/build

Build the UI and start the local server on macOS/Linux.

```bash
npm run build && npm run serve

```

--------------------------------

### Verify Development Environment Setup

Source: https://modelcontextprotocol.org/community/contributing

Run these commands to confirm that Node.js, npm, and Git are installed and meet the required versions. Node.js should be 24.x or higher, npm 11.x or higher, and any recent Git version. These commands work on macOS, Linux, and Windows.

```bash
node --version  # Should be 24.x or higher
npm --version   # Should be 11.x or higher
git --version   # Any recent version

```

--------------------------------

### Start local docs server

Source: https://modelcontextprotocol.org/community/contributing

Launches a live preview of the documentation at http://localhost:3000 with hot reloading.

```bash
npm run serve:docs

```

--------------------------------

### Run MCP client with cargo run

Source: https://modelcontextprotocol.org/docs/2026-07-28/develop/build-client

Use `cargo run --` followed by the command to start the MCP server. Examples are provided for Python, Node.js, and executable servers. Running bare `cargo run` without a server command prints the usage message and exits.

```bash
# Python server
cargo run -- python path/to/server.py

# Node.js server
cargo run -- node path/to/build/index.js

# Executable server
cargo run -- path/to/server-binary

```

--------------------------------

### Set up MCP client and list tools

Source: https://modelcontextprotocol.org/docs/2026-07-28/develop/build-client

Creates an MCP client using StdioClientTransport, connects to the server, and lists available tools.

```csharp
var (command, arguments) = GetCommandAndArguments(args);

var clientTransport = new StdioClientTransport(new()
{
    Name = "Demo Server",
    Command = command,
    Arguments = arguments,
});

await using var mcpClient = await McpClient.CreateAsync(clientTransport);

var tools = await mcpClient.ListToolsAsync();
foreach (var tool in tools)
{
    Console.WriteLine($"Connected to server with tools: {tool.Name}");
}

```

--------------------------------

### GET /v0.1/servers/{serverName}/versions/{version}

Source: https://modelcontextprotocol.org/registry/registry-aggregators

Gets a specific version of a server. Use the special version `latest` to get the latest version.

```APIDOC
## GET /v0.1/servers/{serverName}/versions/{version}

### Description
Gets a specific version of a server. Use the special version `latest` to get the latest version.

### Method
GET

### Endpoint
/v0.1/servers/{serverName}/versions/{version}

### Parameters
#### Path Parameters
- **serverName** (string) - Required - The name of the server. Must be URL-encoded (e.g., `io.modelcontextprotocol%2Feverything`).
- **version** (string) - Required - The version of the server to retrieve. Use `latest` for the latest version.

### Response
#### Success Response (200)
- **server** (object) - The server metadata object.
```

--------------------------------

### Set up Ruby project (macOS/Linux)

Source: https://modelcontextprotocol.org/docs/2026-07-28/develop/build-server

Commands to create a new directory, initialize a Gemfile, add the MCP SDK dependency, and create the server file on macOS/Linux.

```bash
# Create a new directory for our project
mkdir weather
cd weather

# Create a Gemfile
bundle init

# Add the MCP SDK dependency
bundle add mcp

# Create our server file
touch weather.rb

```

--------------------------------

### Verify Node.js Installation

Source: https://modelcontextprotocol.org/docs/2026-07-28/develop/connect-local-servers

Run this command in a terminal or command prompt to check if Node.js is installed. If not installed, download the LTS version from nodejs.org.

```bash
node --version

```

--------------------------------

### Create project directory and install dependencies (Windows)

Source: https://modelcontextprotocol.org/docs/2026-07-28/develop/build-client

Commands to create the project directory, initialize npm, install runtime and dev dependencies, and create the source file. Use on Windows.

```bash
# Create project directory
md mcp-client-typescript
cd mcp-client-typescript

# Initialize npm project
npm init -y

# Install dependencies
npm install @anthropic-ai/sdk @modelcontextprotocol/client dotenv

# Install dev dependencies
npm install -D @types/node typescript

# Create source file
new-item index.ts

```

--------------------------------

### Set up Python project on Windows

Source: https://modelcontextprotocol.org/docs/2026-07-28/develop/build-server

Commands to create a new project, set up a virtual environment, install dependencies, and create the server file on Windows.

```powershell
# Create a new directory for our project
uv init weather
cd weather

# Create virtual environment and activate it
uv venv
.venv\Scripts\activate

# Install dependencies
uv add mcp[cli]

# Create our server file
new-item weather.py

```

--------------------------------

### Basic request example

Source: https://modelcontextprotocol.org/specification/2026-07-28/schema

Example of a basic sampling/createMessage request.

```json
{  
  “messages”: [  
    {  
      “role”: “user”,  
      “content”: {  
        “type”: “text”,  
        “text”: “What is the capital of France?”  
      }  
    }  
  ],  
  “modelPreferences”: {  
    “hints”: [  
      {  
        “name”: “claude-3-sonnet”  
      }  
    ],  
    “intelligencePriority”: 0.8,  
    “speedPriority”: 0.5  
  },  
  “systemPrompt”: “You are a helpful assistant.”,  
  “maxTokens”: 100  
}
```

--------------------------------

### Install Rust (Windows)

Source: https://modelcontextprotocol.org/docs/2026-07-28/develop/build-server

Instructions to download and run rustup-init.exe from rustup.rs on Windows.

```bash
# Download and run rustup-init.exe from https://rustup.rs/

```

--------------------------------

### Install mcp-publisher via Homebrew

Source: https://modelcontextprotocol.org/registry/quickstart

Installs mcp-publisher using Homebrew.

```bash
brew install mcp-publisher
```

--------------------------------

### Install Python SDK

Source: https://modelcontextprotocol.org/extensions/auth/oauth-client-credentials

Install the mcp package using pip.

```bash
pip install mcp

```

--------------------------------

### Set up TypeScript project (Windows)

Source: https://modelcontextprotocol.org/docs/2026-07-28/develop/build-server

Create the project directory, initialize npm, install dependencies (@modelcontextprotocol/server, zod, @types/node, typescript), and create the source file.

```powershell
# Create a new directory for our project
md weather
cd weather

# Initialize a new npm project
npm init -y

# Install dependencies
npm install @modelcontextprotocol/server zod
npm install -D @types/node typescript

# Create our files
md src
new-item src\index.ts

```
Tokens:
Raw