Created
December 14, 2024 01:57
-
-
Save crazyrabbitLTC/4f61848ceb5807a7f05b81c6551a3285 to your computer and use it in GitHub Desktop.
Model Context Protocol Docs - Dec 11 - 2024
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
// Excluded directories: node_modules, docs, .git, discourse-visualizer | |
// Directory: /Users/dennisonbertram/develop/docs | |
// File: /Users/dennisonbertram/develop/docs/examples.mdx | |
--- | |
title: Examples | |
description: 'A list of example servers and implementations' | |
--- | |
This page showcases various Model Context Protocol (MCP) servers that demonstrate the protocol's capabilities and versatility. These servers enable Large Language Models (LLMs) to securely access tools and data sources. | |
## Reference implementations | |
These official reference servers demonstrate core MCP features and SDK usage: | |
### Data and file systems | |
- **[Filesystem](https://github.com/modelcontextprotocol/servers/tree/main/src/filesystem)** - Secure file operations with configurable access controls | |
- **[PostgreSQL](https://github.com/modelcontextprotocol/servers/tree/main/src/postgres)** - Read-only database access with schema inspection capabilities | |
- **[SQLite](https://github.com/modelcontextprotocol/servers/tree/main/src/sqlite)** - Database interaction and business intelligence features | |
- **[Google Drive](https://github.com/modelcontextprotocol/servers/tree/main/src/gdrive)** - File access and search capabilities for Google Drive | |
### Development tools | |
- **[Git](https://github.com/modelcontextprotocol/servers/tree/main/src/git)** - Tools to read, search, and manipulate Git repositories | |
- **[GitHub](https://github.com/modelcontextprotocol/servers/tree/main/src/github)** - Repository management, file operations, and GitHub API integration | |
- **[GitLab](https://github.com/modelcontextprotocol/servers/tree/main/src/gitlab)** - GitLab API integration enabling project management | |
- **[Sentry](https://github.com/modelcontextprotocol/servers/tree/main/src/sentry)** - Retrieving and analyzing issues from Sentry.io | |
### Web and browser automation | |
- **[Brave Search](https://github.com/modelcontextprotocol/servers/tree/main/src/brave-search)** - Web and local search using Brave's Search API | |
- **[Fetch](https://github.com/modelcontextprotocol/servers/tree/main/src/fetch)** - Web content fetching and conversion optimized for LLM usage | |
- **[Puppeteer](https://github.com/modelcontextprotocol/servers/tree/main/src/puppeteer)** - Browser automation and web scraping capabilities | |
### Productivity and communication | |
- **[Slack](https://github.com/modelcontextprotocol/servers/tree/main/src/slack)** - Channel management and messaging capabilities | |
- **[Google Maps](https://github.com/modelcontextprotocol/servers/tree/main/src/google-maps)** - Location services, directions, and place details | |
- **[Memory](https://github.com/modelcontextprotocol/servers/tree/main/src/memory)** - Knowledge graph-based persistent memory system | |
### AI and specialized tools | |
- **[EverArt](https://github.com/modelcontextprotocol/servers/tree/main/src/everart)** - AI image generation using various models | |
- **[Sequential Thinking](https://github.com/modelcontextprotocol/servers/tree/main/src/sequentialthinking)** - Dynamic problem-solving through thought sequences | |
- **[AWS KB Retrieval](https://github.com/modelcontextprotocol/servers/tree/main/src/aws-kb-retrieval-server)** - Retrieval from AWS Knowledge Base using Bedrock Agent Runtime | |
## Official integrations | |
These MCP servers are maintained by companies for their platforms: | |
- **[Axiom](https://github.com/axiomhq/mcp-server-axiom)** - Query and analyze logs, traces, and event data using natural language | |
- **[Browserbase](https://github.com/browserbase/mcp-server-browserbase)** - Automate browser interactions in the cloud | |
- **[Cloudflare](https://github.com/cloudflare/mcp-server-cloudflare)** - Deploy and manage resources on the Cloudflare developer platform | |
- **[E2B](https://github.com/e2b-dev/mcp-server)** - Execute code in secure cloud sandboxes | |
- **[Neon](https://github.com/neondatabase/mcp-server-neon)** - Interact with the Neon serverless Postgres platform | |
- **[Obsidian Markdown Notes](https://github.com/calclavia/mcp-obsidian)** - Read and search through Markdown notes in Obsidian vaults | |
- **[Qdrant](https://github.com/qdrant/mcp-server-qdrant/)** - Implement semantic memory using the Qdrant vector search engine | |
- **[Raygun](https://github.com/MindscapeHQ/mcp-server-raygun)** - Access crash reporting and monitoring data | |
- **[Search1API](https://github.com/fatwang2/search1api-mcp)** - Unified API for search, crawling, and sitemaps | |
- **[Tinybird](https://github.com/tinybirdco/mcp-tinybird)** - Interface with the Tinybird serverless ClickHouse platform | |
## Community highlights | |
A growing ecosystem of community-developed servers extends MCP's capabilities: | |
- **[Docker](https://github.com/ckreiling/mcp-server-docker)** - Manage containers, images, volumes, and networks | |
- **[Kubernetes](https://github.com/Flux159/mcp-server-kubernetes)** - Manage pods, deployments, and services | |
- **[Linear](https://github.com/jerhadf/linear-mcp-server)** - Project management and issue tracking | |
- **[Snowflake](https://github.com/datawiz168/mcp-snowflake-service)** - Interact with Snowflake databases | |
- **[Spotify](https://github.com/varunneal/spotify-mcp)** - Control Spotify playback and manage playlists | |
- **[Todoist](https://github.com/abhiz123/todoist-mcp-server)** - Task management integration | |
> **Note:** Community servers are untested and should be used at your own risk. They are not affiliated with or endorsed by Anthropic. | |
For a complete list of community servers, visit the [MCP Servers Repository](https://github.com/modelcontextprotocol/servers). | |
## Getting started | |
### Using reference servers | |
TypeScript-based servers can be used directly with `npx`: | |
```bash | |
npx -y @modelcontextprotocol/server-memory | |
``` | |
Python-based servers can be used with `uvx` (recommended) or `pip`: | |
```bash | |
# Using uvx | |
uvx mcp-server-git | |
# Using pip | |
pip install mcp-server-git | |
python -m mcp_server_git | |
``` | |
### Configuring with Claude | |
To use an MCP server with Claude, add it to your configuration: | |
```json | |
{ | |
"mcpServers": { | |
"memory": { | |
"command": "npx", | |
"args": ["-y", "@modelcontextprotocol/server-memory"] | |
}, | |
"filesystem": { | |
"command": "npx", | |
"args": ["-y", "@modelcontextprotocol/server-filesystem", "/path/to/allowed/files"] | |
}, | |
"github": { | |
"command": "npx", | |
"args": ["-y", "@modelcontextprotocol/server-github"], | |
"env": { | |
"GITHUB_PERSONAL_ACCESS_TOKEN": "<YOUR_TOKEN>" | |
} | |
} | |
} | |
} | |
``` | |
## Additional resources | |
- [MCP Servers Repository](https://github.com/modelcontextprotocol/servers) - Complete collection of reference implementations and community servers | |
- [Awesome MCP Servers](https://github.com/punkpeye/awesome-mcp-servers) - Curated list of MCP servers | |
- [MCP CLI](https://github.com/wong2/mcp-cli) - Command-line inspector for testing MCP servers | |
- [MCP Get](https://mcp-get.com) - Tool for installing and managing MCP servers | |
Visit our [GitHub Discussions](https://github.com/orgs/modelcontextprotocol/discussions) to engage with the MCP community. | |
// File: /Users/dennisonbertram/develop/docs/snippets/snippet-intro.mdx | |
One of the core principles of software development is DRY (Don't Repeat | |
Yourself). This is a principle that apply to documentation as | |
well. If you find yourself repeating the same content in multiple places, you | |
should consider creating a custom snippet to keep your content in sync. | |
// File: /Users/dennisonbertram/develop/docs/flatten.js | |
#!/usr/bin/env node | |
const fs = require('fs'); | |
const path = require('path'); | |
// Default ignored directories and extensions | |
const DEFAULT_IGNORED_DIRS = ['node_modules', 'docs', '.git', 'discourse-visualizer']; | |
const DEFAULT_IGNORED_EXTENSIONS = [ | |
// '.md', | |
'.env', | |
'.log', | |
'.json', | |
'.sqlite', | |
'.sqlite3', | |
'.db', | |
'.db3', | |
'.lockb', | |
]; | |
function parseArguments() { | |
const args = process.argv.slice(2); | |
const result = { | |
targetDirs: [], | |
excludeDirs: [...DEFAULT_IGNORED_DIRS], | |
}; | |
let i = 0; | |
while (i < args.length) { | |
if (args[i] === '--exclude' || args[i] === '-e') { | |
i++; | |
if (i < args.length) { | |
// Split by comma if multiple directories are provided in one argument | |
const excludes = args[i].split(',').map(dir => dir.trim()); | |
result.excludeDirs.push(...excludes); | |
} | |
} else { | |
result.targetDirs.push(path.resolve(args[i])); | |
} | |
i++; | |
} | |
// If no target directories specified, use current directory | |
if (result.targetDirs.length === 0) { | |
result.targetDirs.push(process.cwd()); | |
} | |
return result; | |
} | |
function crawlDirectory(dir, excludeDirs) { | |
let output = ''; | |
const files = fs.readdirSync(dir); | |
for (const file of files) { | |
const filePath = path.join(dir, file); | |
const stats = fs.statSync(filePath); | |
if (stats.isDirectory()) { | |
if (!excludeDirs.includes(file)) { | |
output += crawlDirectory(filePath, excludeDirs); | |
} | |
} else if (stats.isFile()) { | |
const ext = path.extname(file); | |
if ( | |
['.js', '.ts', '.jsx', '.tsx', '.cjs', '.mdx'].includes(ext) && | |
!DEFAULT_IGNORED_EXTENSIONS.includes(ext) | |
) { | |
output += `\n// File: ${filePath}\n`; | |
output += fs.readFileSync(filePath, 'utf-8'); | |
output += '\n'; | |
} | |
} | |
} | |
return output; | |
} | |
function main() { | |
const { targetDirs, excludeDirs } = parseArguments(); | |
// Validate all provided directories | |
for (const dir of targetDirs) { | |
if (!fs.existsSync(dir) || !fs.statSync(dir).isDirectory()) { | |
console.error(`Error: The provided path "${dir}" is not a valid directory.`); | |
process.exit(1); | |
} | |
} | |
let output = ''; | |
// Add information about excluded directories | |
output += `// Excluded directories: ${excludeDirs.join(', ')}\n\n`; | |
for (const dir of targetDirs) { | |
output += `\n// Directory: ${dir}\n`; | |
output += crawlDirectory(dir, excludeDirs); | |
} | |
const outputDir = process.cwd(); | |
const outputPath = path.join(outputDir, 'flattened_code.txt'); | |
fs.writeFileSync(outputPath, output); | |
console.log( | |
`Flattened code from ${targetDirs.length} director${ | |
targetDirs.length > 1 ? 'ies' : 'y' | |
} has been saved to ${outputPath}` | |
); | |
console.log(`Excluded directories: ${excludeDirs.join(', ')}`); | |
} | |
main(); | |
// # Use default excludes only | |
// ./script.js /path/to/directory | |
// # Exclude additional directories | |
// ./script.js /path/to/directory --exclude build,dist | |
// # Multiple target directories with excludes | |
// ./script.js /path/1 /path/2 -e temp,cache | |
// # Comma or space-separated excludes | |
// ./script.js . --exclude build dist temp | |
// ./script.js . --exclude build,dist,temp | |
// File: /Users/dennisonbertram/develop/docs/introduction.mdx | |
--- | |
title: Introduction | |
description: 'Get started with the Model Context Protocol (MCP)' | |
--- | |
MCP is an open protocol that standardizes how applications provide context to LLMs. Think of MCP like a USB-C port for AI applications. Just as USB-C provides a standardized way to connect your devices to various peripherals and accessories, MCP provides a standardized way to connect AI models to different data sources and tools. | |
## Why MCP? | |
MCP helps you build agents and complex workflows on top of LLMs. LLMs frequently need to integrate with data and tools, and MCP provides: | |
- A growing list of pre-built integrations that your LLM can directly plug into | |
- The flexibility to switch between LLM providers and vendors | |
- Best practices for securing your data within your infrastructure | |
### General architecture | |
At its core, MCP follows a client-server architecture where a host application can connect to multiple servers: | |
```mermaid | |
flowchart LR | |
subgraph "Your Computer" | |
Host["MCP Host\n(Claude, IDEs, Tools)"] | |
S1["MCP Server A"] | |
S2["MCP Server B"] | |
S3["MCP Server C"] | |
Host <-->|"MCP Protocol"| S1 | |
Host <-->|"MCP Protocol"| S2 | |
Host <-->|"MCP Protocol"| S3 | |
S1 <--> D1[("Local\nData Source A")] | |
S2 <--> D2[("Local\nData Source B")] | |
end | |
subgraph "Internet" | |
S3 <-->|"Web APIs"| D3[("Remote\nService C")] | |
end | |
``` | |
- **MCP Hosts**: Programs like Claude Desktop, IDEs, or AI tools that want to access data through MCP | |
- **MCP Clients**: Protocol clients that maintain 1:1 connections with servers | |
- **MCP Servers**: Lightweight programs that each expose specific capabilities through the standardized Model Context Protocol | |
- **Local Data Sources**: Your computer's files, databases, and services that MCP servers can securely access | |
- **Remote Services**: External systems available over the internet (e.g., through APIs) that MCP servers can connect to | |
## Get started | |
Choose the path that best fits your needs: | |
<CardGroup cols={2}> | |
<Card | |
title="Quickstart" | |
icon="bolt" | |
href="/quickstart" | |
> | |
Build and connect to your first MCP server | |
</Card> | |
<Card | |
title="Examples" | |
icon="grid" | |
href="/examples" | |
> | |
Check out our gallery of official MCP servers and implementations | |
</Card> | |
<Card | |
title="Clients" | |
icon="cubes" | |
href="/clients" | |
> | |
View the list of clients that support MCP integrations | |
</Card> | |
</CardGroup> | |
## Tutorials | |
<CardGroup cols={2}> | |
<Card | |
title="Building a MCP client" | |
icon="outlet" | |
href="/tutorials/building-a-client" | |
> | |
Learn how to build your first MCP client | |
</Card> | |
<Card | |
title="Building MCP with LLMs" | |
icon="comments" | |
href="/tutorials/building-mcp-with-llms" | |
> | |
Learn how to use LLMs like Claude to speed up your MCP development | |
</Card> | |
<Card | |
title="Debugging Guide" | |
icon="bug" | |
href="/docs/tools/debugging"> | |
Learn how to effectively debug MCP servers and integrations | |
</Card> | |
<Card | |
title="MCP Inspector" | |
icon="magnifying-glass" | |
href="/docs/tools/inspector" | |
> | |
Test and inspect your MCP servers with our interactive debugging tool | |
</Card> | |
</CardGroup> | |
## Explore MCP | |
Dive deeper into MCP's core concepts and capabilities: | |
<CardGroup cols={2}> | |
<Card | |
title="Core architecture" | |
icon="sitemap" | |
href="/docs/concepts/architecture" | |
> | |
Understand how MCP connects clients, servers, and LLMs | |
</Card> | |
<Card | |
title="Resources" | |
icon="database" | |
href="/docs/concepts/resources" | |
> | |
Expose data and content from your servers to LLMs | |
</Card> | |
<Card | |
title="Prompts" | |
icon="message" | |
href="/docs/concepts/prompts" | |
> | |
Create reusable prompt templates and workflows | |
</Card> | |
<Card | |
title="Tools" | |
icon="wrench" | |
href="/docs/concepts/tools" | |
> | |
Enable LLMs to perform actions through your server | |
</Card> | |
<Card | |
title="Sampling" | |
icon="robot" | |
href="/docs/concepts/sampling" | |
> | |
Let your servers request completions from LLMs | |
</Card> | |
<Card | |
title="Transports" | |
icon="network-wired" | |
href="/docs/concepts/transports" | |
> | |
Learn about MCP's communication mechanism | |
</Card> | |
</CardGroup> | |
## Contributing | |
Want to contribute? Check out [@modelcontextprotocol](https://github.com/modelcontextprotocol) on GitHub to join our growing community of developers building with MCP. | |
// File: /Users/dennisonbertram/develop/docs/clients.mdx | |
--- | |
title: "Clients" | |
description: "A list of applications that support MCP integrations" | |
--- | |
This page provides an overview of applications that support the Model Context Protocol (MCP). Each client may support different MCP features, allowing for varying levels of integration with MCP servers. | |
## Feature support matrix | |
| Client | [Resources] | [Prompts] | [Tools] | [Sampling] | Roots | Notes | | |
|---------------------------|-------------|-----------|---------|------------|-------|---------------------------------------------------| | |
| [Claude Desktop App][Claude] | ✅ | ✅ | ✅ | ❌ | ❌ | Full support for all MCP features | | |
| [Zed][Zed] | ❌ | ✅ | ❌ | ❌ | ❌ | Prompts appear as slash commands | | |
| [Sourcegraph Cody][Cody] | ✅ | ❌ | ❌ | ❌ | ❌ | Supports resources through OpenCTX | | |
| [Firebase Genkit][Genkit] | ⚠️ | ✅ | ✅ | ❌ | ❌ | Supports resource list and lookup through tools. | | |
| [Continue][Continue] | ✅ | ✅ | ✅ | ❌ | ❌ | Full support for all MCP features | | |
| [GenAIScript][GenAIScript] | ❌ | ❌ | ✅ | ❌ | ❌ | Supports tools. | | |
[Claude]: https://claude.ai/download | |
[Zed]: https://zed.dev | |
[Cody]: https://sourcegraph.com/cody | |
[Genkit]: https://github.com/firebase/genkit | |
[Continue]: https://github.com/continuedev/continue | |
[GenAIScript]: https://microsoft.github.io/genaiscript/reference/scripts/mcp-tools/ | |
[Resources]: https://modelcontextprotocol.io/docs/concepts/resources | |
[Prompts]: https://modelcontextprotocol.io/docs/concepts/prompts | |
[Tools]: https://modelcontextprotocol.io/docs/concepts/tools | |
[Sampling]: https://modelcontextprotocol.io/docs/concepts/sampling | |
## Client details | |
### Claude Desktop App | |
The Claude desktop application provides comprehensive support for MCP, enabling deep integration with local tools and data sources. | |
**Key features:** | |
- Full support for resources, allowing attachment of local files and data | |
- Support for prompt templates | |
- Tool integration for executing commands and scripts | |
- Local server connections for enhanced privacy and security | |
> ⓘ Note: The Claude.ai web application does not currently support MCP. MCP features are only available in the desktop application. | |
### Zed | |
[Zed](https://zed.dev/docs/assistant/model-context-protocol) is a high-performance code editor with built-in MCP support, focusing on prompt templates and tool integration. | |
**Key features:** | |
- Prompt templates surface as slash commands in the editor | |
- Tool integration for enhanced coding workflows | |
- Tight integration with editor features and workspace context | |
- Does not support MCP resources | |
### Sourcegraph Cody | |
[Cody](https://openctx.org/docs/providers/modelcontextprotocol) is Sourcegraph's AI coding assistant, which implements MCP through OpenCTX. | |
**Key features:** | |
- Support for MCP resources | |
- Integration with Sourcegraph's code intelligence | |
- Uses OpenCTX as an abstraction layer | |
- Future support planned for additional MCP features | |
### Firebase Genkit | |
[Genkit](https://github.com/firebase/genkit) is Firebase's SDK for building and integrating GenAI features into applications. The [genkitx-mcp](https://github.com/firebase/genkit/tree/main/js/plugins/mcp) plugin enables consuming MCP servers as a client or creating MCP servers from Genkit tools and prompts. | |
**Key features:** | |
- Client support for tools and prompts (resources partially supported) | |
- Rich discovery with support in Genkit's Dev UI playground | |
- Seamless interoperability with Genkit's existing tools and prompts | |
- Works across a wide variety of GenAI models from top providers | |
### Continue | |
[Continue](https://github.com/continuedev/continue) is an open-source AI code assistant, with built-in support for all MCP features. | |
**Key features** | |
- Type "@" to mention MCP resources | |
- Prompt templates surface as slash commands | |
- Use both built-in and MCP tools directly in chat | |
- Supports VS Code and JetBrains IDEs, with any LLM | |
### GenAIScript | |
Programmatically assemble prompts for LLMs using [GenAIScript](https://microsoft.github.io/genaiscript/) (in JavaScript). Orchestrate LLMs, tools, and data in JavaScript. | |
**Key features:** | |
- JavaScript toolbox to work with prompts | |
- Abstraction to make it easy and productive | |
- Seamless Visual Studio Code integration | |
## Adding MCP support to your application | |
If you've added MCP support to your application, we encourage you to submit a pull request to add it to this list. MCP integration can provide your users with powerful contextual AI capabilities and make your application part of the growing MCP ecosystem. | |
Benefits of adding MCP support: | |
- Enable users to bring their own context and tools | |
- Join a growing ecosystem of interoperable AI applications | |
- Provide users with flexible integration options | |
- Support local-first AI workflows | |
To get started with implementing MCP in your application, check out our [Python](https://github.com/modelcontextprotocol/python-sdk) or [TypeScript SDK Documentation](https://github.com/modelcontextprotocol/typescript-sdk) | |
## Updates and corrections | |
This list is maintained by the community. If you notice any inaccuracies or would like to update information about MCP support in your application, please submit a pull request or [open an issue in our documentation repository](https://github.com/modelcontextprotocol/docs/issues). | |
// File: /Users/dennisonbertram/develop/docs/tutorials/building-a-client.mdx | |
--- | |
title: "Building MCP clients" | |
description: "Learn how to build your first client in MCP" | |
--- | |
In this tutorial, you'll learn how to build a LLM-powered chatbot client that connects to MCP servers. It helps to have gone through the [Quickstart tutorial](/quickstart) that guides you through the basic of building your first server. | |
<Tabs> | |
<Tab title="Python"> | |
[You can find the complete code for this tutorial here.](https://github.com/modelcontextprotocol/quickstart-resources/tree/main/mcp-client) | |
## System Requirements | |
Before starting, ensure your system meets these requirements: | |
- Mac or Windows computer | |
- Latest Python version installed | |
- Latest version of `uv` installed | |
## Setting Up Your Environment | |
First, create a new Python project with `uv`: | |
```bash | |
# Create project directory | |
uv init mcp-client | |
cd mcp-client | |
# Create virtual environment | |
uv venv | |
# Activate virtual environment | |
# On Windows: | |
.venv\Scripts\activate | |
# On Unix or MacOS: | |
source .venv/bin/activate | |
# Install required packages | |
uv add mcp anthropic python-dotenv | |
# Remove boilerplate files | |
rm hello.py | |
# Create our main file | |
touch client.py | |
``` | |
## Setting Up Your API Key | |
You'll need an Anthropic API key from the [Anthropic Console](https://console.anthropic.com/settings/keys). | |
Create a `.env` file to store it: | |
```bash | |
# Create .env file | |
touch .env | |
``` | |
Add your key to the `.env` file: | |
```bash | |
ANTHROPIC_API_KEY=<your key here> | |
``` | |
Add `.env` to your `.gitignore`: | |
```bash | |
echo ".env" >> .gitignore | |
``` | |
<Warning> | |
Make sure you keep your `ANTHROPIC_API_KEY` secure! | |
</Warning> | |
## Creating the Client | |
### Basic Client Structure | |
First, let's set up our imports and create the basic client class: | |
```python | |
import asyncio | |
from typing import Optional | |
from contextlib import AsyncExitStack | |
from mcp import ClientSession, StdioServerParameters | |
from mcp.client.stdio import stdio_client | |
from anthropic import Anthropic | |
from dotenv import load_dotenv | |
load_dotenv() # load environment variables from .env | |
class MCPClient: | |
def __init__(self): | |
# Initialize session and client objects | |
self.session: Optional[ClientSession] = None | |
self.exit_stack = AsyncExitStack() | |
self.anthropic = Anthropic() | |
# methods will go here | |
``` | |
### Server Connection Management | |
Next, we'll implement the method to connect to an MCP server: | |
```python | |
async def connect_to_server(self, server_script_path: str): | |
"""Connect to an MCP server | |
Args: | |
server_script_path: Path to the server script (.py or .js) | |
""" | |
is_python = server_script_path.endswith('.py') | |
is_js = server_script_path.endswith('.js') | |
if not (is_python or is_js): | |
raise ValueError("Server script must be a .py or .js file") | |
command = "python" if is_python else "node" | |
server_params = StdioServerParameters( | |
command=command, | |
args=[server_script_path], | |
env=None | |
) | |
stdio_transport = await self.exit_stack.enter_async_context(stdio_client(server_params)) | |
self.stdio, self.write = stdio_transport | |
self.session = await self.exit_stack.enter_async_context(ClientSession(self.stdio, self.write)) | |
await self.session.initialize() | |
# List available tools | |
response = await self.session.list_tools() | |
tools = response.tools | |
print("\nConnected to server with tools:", [tool.name for tool in tools]) | |
``` | |
### Query Processing Logic | |
Now let's add the core functionality for processing queries and handling tool calls: | |
```python | |
async def process_query(self, query: str) -> str: | |
"""Process a query using Claude and available tools""" | |
messages = [ | |
{ | |
"role": "user", | |
"content": query | |
} | |
] | |
response = await self.session.list_tools() | |
available_tools = [{ | |
"name": tool.name, | |
"description": tool.description, | |
"input_schema": tool.inputSchema | |
} for tool in response.tools] | |
# Initial Claude API call | |
response = self.anthropic.messages.create( | |
model="claude-3-5-sonnet-20241022", | |
max_tokens=1000, | |
messages=messages, | |
tools=available_tools | |
) | |
# Process response and handle tool calls | |
tool_results = [] | |
final_text = [] | |
for content in response.content: | |
if content.type == 'text': | |
final_text.append(content.text) | |
elif content.type == 'tool_use': | |
tool_name = content.name | |
tool_args = content.input | |
# Execute tool call | |
result = await self.session.call_tool(tool_name, tool_args) | |
tool_results.append({"call": tool_name, "result": result}) | |
final_text.append(f"[Calling tool {tool_name} with args {tool_args}]") | |
# Continue conversation with tool results | |
if hasattr(content, 'text') and content.text: | |
messages.append({ | |
"role": "assistant", | |
"content": content.text | |
}) | |
messages.append({ | |
"role": "user", | |
"content": result.content | |
}) | |
# Get next response from Claude | |
response = self.anthropic.messages.create( | |
model="claude-3-5-sonnet-20241022", | |
max_tokens=1000, | |
messages=messages, | |
) | |
final_text.append(response.content[0].text) | |
return "\n".join(final_text) | |
``` | |
### Interactive Chat Interface | |
Now we'll add the chat loop and cleanup functionality: | |
```python | |
async def chat_loop(self): | |
"""Run an interactive chat loop""" | |
print("\nMCP Client Started!") | |
print("Type your queries or 'quit' to exit.") | |
while True: | |
try: | |
query = input("\nQuery: ").strip() | |
if query.lower() == 'quit': | |
break | |
response = await self.process_query(query) | |
print("\n" + response) | |
except Exception as e: | |
print(f"\nError: {str(e)}") | |
async def cleanup(self): | |
"""Clean up resources""" | |
await self.exit_stack.aclose() | |
``` | |
### Main Entry Point | |
Finally, we'll add the main execution logic: | |
```python | |
async def main(): | |
if len(sys.argv) < 2: | |
print("Usage: python client.py <path_to_server_script>") | |
sys.exit(1) | |
client = MCPClient() | |
try: | |
await client.connect_to_server(sys.argv[1]) | |
await client.chat_loop() | |
finally: | |
await client.cleanup() | |
if __name__ == "__main__": | |
import sys | |
asyncio.run(main()) | |
``` | |
You can find the complete `client.py` file [here.](https://gist.github.com/zckly/f3f28ea731e096e53b39b47bf0a2d4b1) | |
## Key Components Explained | |
### 1. Client Initialization | |
- The `MCPClient` class initializes with session management and API clients | |
- Uses `AsyncExitStack` for proper resource management | |
- Configures the Anthropic client for Claude interactions | |
### 2. Server Connection | |
- Supports both Python and Node.js servers | |
- Validates server script type | |
- Sets up proper communication channels | |
- Initializes the session and lists available tools | |
### 3. Query Processing | |
- Maintains conversation context | |
- Handles Claude's responses and tool calls | |
- Manages the message flow between Claude and tools | |
- Combines results into a coherent response | |
### 4. Interactive Interface | |
- Provides a simple command-line interface | |
- Handles user input and displays responses | |
- Includes basic error handling | |
- Allows graceful exit | |
### 5. Resource Management | |
- Proper cleanup of resources | |
- Error handling for connection issues | |
- Graceful shutdown procedures | |
## Common Customization Points | |
1. **Tool Handling** | |
- Modify `process_query()` to handle specific tool types | |
- Add custom error handling for tool calls | |
- Implement tool-specific response formatting | |
2. **Response Processing** | |
- Customize how tool results are formatted | |
- Add response filtering or transformation | |
- Implement custom logging | |
3. **User Interface** | |
- Add a GUI or web interface | |
- Implement rich console output | |
- Add command history or auto-completion | |
## Running the Client | |
To run your client with any MCP server: | |
```bash | |
uv run client.py path/to/server.py # python server | |
uv run client.py path/to/build/index.js # node server | |
``` | |
<Note> | |
If you're continuing the weather tutorial from the quickstart, your command might look something like this: `python client.py .../weather/src/weather/server.py` | |
</Note> | |
The client will: | |
1. Connect to the specified server | |
2. List available tools | |
3. Start an interactive chat session where you can: | |
- Enter queries | |
- See tool executions | |
- Get responses from Claude | |
Here's an example of what it should look like if connected to the weather server from the quickstart: | |
<Frame> | |
<img src="/images/client-claude-cli-python.png" /> | |
</Frame> | |
## How It Works | |
When you submit a query: | |
1. The client gets the list of available tools from the server | |
2. Your query is sent to Claude along with tool descriptions | |
3. Claude decides which tools (if any) to use | |
4. The client executes any requested tool calls through the server | |
5. Results are sent back to Claude | |
6. Claude provides a natural language response | |
7. The response is displayed to you | |
## Best practices | |
1. **Error Handling** | |
- Always wrap tool calls in try-catch blocks | |
- Provide meaningful error messages | |
- Gracefully handle connection issues | |
2. **Resource Management** | |
- Use `AsyncExitStack` for proper cleanup | |
- Close connections when done | |
- Handle server disconnections | |
3. **Security** | |
- Store API keys securely in `.env` | |
- Validate server responses | |
- Be cautious with tool permissions | |
## Troubleshooting | |
### Server Path Issues | |
- Double-check the path to your server script is correct | |
- Use the absolute path if the relative path isn't working | |
- For Windows users, make sure to use forward slashes (/) or escaped backslashes (\\) in the path | |
- Verify the server file has the correct extension (.py for Python or .js for Node.js) | |
Example of correct path usage: | |
```bash | |
# Relative path | |
uv run client.py ./server/weather.py | |
# Absolute path | |
uv run client.py /Users/username/projects/mcp-server/weather.py | |
# Windows path (either format works) | |
uv run client.py C:/projects/mcp-server/weather.py | |
uv run client.py C:\\projects\\mcp-server\\weather.py | |
``` | |
### Response Timing | |
- The first response might take up to 30 seconds to return | |
- This is normal and happens while: | |
- The server initializes | |
- Claude processes the query | |
- Tools are being executed | |
- Subsequent responses are typically faster | |
- Don't interrupt the process during this initial waiting period | |
### Common Error Messages | |
If you see: | |
- `FileNotFoundError`: Check your server path | |
- `Connection refused`: Ensure the server is running and the path is correct | |
- `Tool execution failed`: Verify the tool's required environment variables are set | |
- `Timeout error`: Consider increasing the timeout in your client configuration | |
</Tab> | |
</Tabs> | |
## Next steps | |
<CardGroup cols={2}> | |
<Card | |
title="Example servers" | |
icon="grid" | |
href="/examples" | |
> | |
Check out our gallery of official MCP servers and implementations | |
</Card> | |
<Card | |
title="Clients" | |
icon="cubes" | |
href="/clients" | |
> | |
View the list of clients that support MCP integrations | |
</Card> | |
<Card | |
title="Building MCP with LLMs" | |
icon="comments" | |
href="/building-mcp-with-llms" | |
> | |
Learn how to use LLMs like Claude to speed up your MCP development | |
</Card> | |
<Card | |
title="Core architecture" | |
icon="sitemap" | |
href="/docs/concepts/architecture" | |
> | |
Understand how MCP connects clients, servers, and LLMs | |
</Card> | |
</CardGroup> | |
// File: /Users/dennisonbertram/develop/docs/tutorials/building-mcp-with-llms.mdx | |
--- | |
title: "Building MCP with LLMs" | |
description: "Speed up your MCP development using LLMs such as Claude!" | |
--- | |
This guide will help you use LLMs to help you build custom Model Context Protocol (MCP) servers and clients. We'll be focusing on Claude for this tutorial, but you can do this with any frontier LLM. | |
## Preparing the documentation | |
Before starting, gather the necessary documentation to help Claude understand MCP: | |
1. Visit https://modelcontextprotocol.io/llms-full.txt and copy the full documentation text | |
2. Navigate to either the [MCP TypeScript SDK](https://github.com/modelcontextprotocol/typescript-sdk) or [Python SDK repository](https://github.com/modelcontextprotocol/python-sdk) | |
3. Copy the README files and other relevant documentation | |
4. Paste these documents into your conversation with Claude | |
## Describing your server | |
Once you've provided the documentation, clearly describe to Claude what kind of server you want to build. Be specific about: | |
- What resources your server will expose | |
- What tools it will provide | |
- Any prompts it should offer | |
- What external systems it needs to interact with | |
For example: | |
``` | |
Build an MCP server that: | |
- Connects to my company's PostgreSQL database | |
- Exposes table schemas as resources | |
- Provides tools for running read-only SQL queries | |
- Includes prompts for common data analysis tasks | |
``` | |
## Working with Claude | |
When working with Claude on MCP servers: | |
1. Start with the core functionality first, then iterate to add more features | |
2. Ask Claude to explain any parts of the code you don't understand | |
3. Request modifications or improvements as needed | |
4. Have Claude help you test the server and handle edge cases | |
Claude can help implement all the key MCP features: | |
- Resource management and exposure | |
- Tool definitions and implementations | |
- Prompt templates and handlers | |
- Error handling and logging | |
- Connection and transport setup | |
## Best practices | |
When building MCP servers with Claude: | |
- Break down complex servers into smaller pieces | |
- Test each component thoroughly before moving on | |
- Keep security in mind - validate inputs and limit access appropriately | |
- Document your code well for future maintenance | |
- Follow MCP protocol specifications carefully | |
## Next steps | |
After Claude helps you build your server: | |
1. Review the generated code carefully | |
2. Test the server with the MCP Inspector tool | |
3. Connect it to Claude.app or other MCP clients | |
4. Iterate based on real usage and feedback | |
Remember that Claude can help you modify and improve your server as requirements change over time. | |
Need more guidance? Just ask Claude specific questions about implementing MCP features or troubleshooting issues that arise. | |
// File: /Users/dennisonbertram/develop/docs/tutorials/building-a-client-node.mdx | |
<Tab title="Node"> | |
## System Requirements | |
Before starting, ensure your system meets these requirements: | |
- Mac or Windows computer | |
- Node.js version 16 or higher installed | |
- npm (comes with Node.js) | |
## Setting Up Your Environment | |
First, create a new Node.js project: | |
```bash | |
# Create project directory | |
mkdir mcp-client | |
cd mcp-client | |
# Initialize npm project | |
npm init -y | |
# Install dependencies | |
npm install @modelcontextprotocol/sdk @anthropic-ai/sdk dotenv | |
npm install -D typescript @types/node | |
# Create TypeScript config | |
npx tsc --init | |
# Create necessary files | |
mkdir src | |
touch src/client.ts | |
touch .env | |
``` | |
Update your `package.json` to add necessary configuration: | |
```json | |
{ | |
"type": "module", | |
"scripts": { | |
"build": "tsc", | |
"start": "node build/client.js" | |
} | |
} | |
``` | |
Update your `tsconfig.json` with appropriate settings: | |
```json | |
{ | |
"compilerOptions": { | |
"target": "ES2022", | |
"module": "Node16", | |
"moduleResolution": "Node16", | |
"outDir": "./build", | |
"rootDir": "./src", | |
"strict": true, | |
"esModuleInterop": true, | |
"skipLibCheck": true, | |
"forceConsistentCasingInFileNames": true | |
}, | |
"include": ["src/**/*"] | |
} | |
``` | |
## Setting Up Your API Key | |
You'll need an Anthropic API key from the [Anthropic Console](https://console.anthropic.com/settings/keys). | |
Create a `.env` file: | |
```bash | |
ANTHROPIC_API_KEY=your_key_here | |
``` | |
Add `.env` to your `.gitignore`: | |
```bash | |
echo ".env" >> .gitignore | |
``` | |
## Creating the Client | |
First, let's set up our imports and create the basic client class in `src/client.ts`: | |
```typescript | |
import { Client } from "@modelcontextprotocol/sdk/client/index.js"; | |
import { StdioClientTransport } from "@modelcontextprotocol/sdk/client/stdio.js"; | |
import Anthropic from "@anthropic-ai/sdk"; | |
import dotenv from "dotenv"; | |
import { Tool } from "@anthropic-ai/sdk/resources/messages.js"; | |
import { | |
CallToolResultSchema, | |
ListToolsResultSchema, | |
} from "@modelcontextprotocol/sdk/types.js"; | |
import * as readline from "node:readline"; | |
dotenv.config(); | |
interface MCPClientConfig { | |
name?: string; | |
version?: string; | |
} | |
class MCPClient { | |
private client: Client | null = null; | |
private anthropic: Anthropic; | |
private transport: StdioClientTransport | null = null; | |
constructor(config: MCPClientConfig = {}) { | |
this.anthropic = new Anthropic(); | |
} | |
// Methods will go here | |
} | |
``` | |
## Server Connection Management | |
Next, implement the method to connect to an MCP server: | |
```typescript | |
async connectToServer(serverScriptPath: string): Promise<void> { | |
const isPython = serverScriptPath.endsWith(".py"); | |
const isJs = serverScriptPath.endsWith(".js"); | |
if (!isPython && !isJs) { | |
throw new Error("Server script must be a .py or .js file"); | |
} | |
const command = isPython ? "python" : "node"; | |
this.transport = new StdioClientTransport({ | |
command, | |
args: [serverScriptPath], | |
}); | |
this.client = new Client( | |
{ | |
name: "mcp-client", | |
version: "1.0.0", | |
}, | |
{ | |
capabilities: {}, | |
} | |
); | |
await this.client.connect(this.transport); | |
// List available tools | |
const response = await this.client.request( | |
{ method: "tools/list" }, | |
ListToolsResultSchema | |
); | |
console.log( | |
"\nConnected to server with tools:", | |
response.tools.map((tool: any) => tool.name) | |
); | |
} | |
``` | |
## Query Processing Logic | |
Now add the core functionality for processing queries and handling tool calls: | |
```typescript | |
async processQuery(query: string): Promise<string> { | |
if (!this.client) { | |
throw new Error("Client not connected"); | |
} | |
// Initialize messages array with user query | |
let messages: Anthropic.MessageParam[] = [ | |
{ | |
role: "user", | |
content: query, | |
}, | |
]; | |
// Get available tools | |
const toolsResponse = await this.client.request( | |
{ method: "tools/list" }, | |
ListToolsResultSchema | |
); | |
const availableTools: Tool[] = toolsResponse.tools.map((tool: any) => ({ | |
name: tool.name, | |
description: tool.description, | |
input_schema: tool.inputSchema, | |
})); | |
const finalText: string[] = []; | |
let currentResponse = await this.anthropic.messages.create({ | |
model: "claude-3-5-sonnet-20241022", | |
max_tokens: 1000, | |
messages, | |
tools: availableTools, | |
}); | |
// Process the response and any tool calls | |
while (true) { | |
// Add Claude's response to final text and messages | |
for (const content of currentResponse.content) { | |
if (content.type === "text") { | |
finalText.push(content.text); | |
} else if (content.type === "tool_use") { | |
const toolName = content.name; | |
const toolArgs = content.input; | |
// Execute tool call | |
const result = await this.client.request( | |
{ | |
method: "tools/call", | |
params: { | |
name: toolName, | |
args: toolArgs, | |
}, | |
}, | |
CallToolResultSchema | |
); | |
finalText.push( | |
`[Calling tool ${toolName} with args ${JSON.stringify(toolArgs)}]` | |
); | |
// Add Claude's response (including tool use) to messages | |
messages.push({ | |
role: "assistant", | |
content: currentResponse.content, | |
}); | |
// Add tool result to messages | |
messages.push({ | |
role: "user", | |
content: [ | |
{ | |
type: "tool_result", | |
tool_use_id: content.id, | |
content: [ | |
{ type: "text", text: JSON.stringify(result.content) }, | |
], | |
}, | |
], | |
}); | |
// Get next response from Claude with tool results | |
currentResponse = await this.anthropic.messages.create({ | |
model: "claude-3-5-sonnet-20241022", | |
max_tokens: 1000, | |
messages, | |
tools: availableTools, | |
}); | |
// Add Claude's interpretation of the tool results to final text | |
if (currentResponse.content[0]?.type === "text") { | |
finalText.push(currentResponse.content[0].text); | |
} | |
// Continue the loop to process any additional tool calls | |
continue; | |
} | |
} | |
// If we reach here, there were no tool calls in the response | |
break; | |
} | |
return finalText.join("\n"); | |
} | |
``` | |
## Interactive Chat Interface | |
Add the chat loop and cleanup functionality: | |
```typescript | |
async chatLoop(): Promise<void> { | |
console.log("\nMCP Client Started!"); | |
console.log("Type your queries or 'quit' to exit."); | |
// Using Node's readline for console input | |
const rl = readline.createInterface({ | |
input: process.stdin, | |
output: process.stdout, | |
}); | |
const askQuestion = () => { | |
rl.question("\nQuery: ", async (query: string) => { | |
try { | |
if (query.toLowerCase() === "quit") { | |
await this.cleanup(); | |
rl.close(); | |
return; | |
} | |
const response = await this.processQuery(query); | |
console.log("\n" + response); | |
askQuestion(); | |
} catch (error) { | |
console.error("\nError:", error); | |
askQuestion(); | |
} | |
}); | |
}; | |
askQuestion(); | |
} | |
async cleanup(): Promise<void> { | |
if (this.transport) { | |
await this.transport.close(); | |
} | |
} | |
``` | |
## Main Entry Point | |
Finally, add the main execution logic outside the class: | |
```typescript | |
// Main execution | |
async function main() { | |
if (process.argv.length < 3) { | |
console.log("Usage: ts-node client.ts <path_to_server_script>"); | |
process.exit(1); | |
} | |
const client = new MCPClient(); | |
try { | |
await client.connectToServer(process.argv[2]); | |
await client.chatLoop(); | |
} catch (error) { | |
console.error("Error:", error); | |
await client.cleanup(); | |
process.exit(1); | |
} | |
} | |
// Run main if this is the main module | |
if (import.meta.url === new URL(process.argv[1], "file:").href) { | |
main(); | |
} | |
export default MCPClient; | |
``` | |
## Running the Client | |
To run your client with any MCP server: | |
```bash | |
# Build the TypeScript code. Make sure to rerun this every time you update `client.ts`! | |
npm run build | |
# Run the client | |
node build/client.js path/to/server.py # for Python servers | |
node build/client.js path/to/server.js # for Node.js servers | |
``` | |
The client will: | |
1. Connect to the specified server | |
2. List available tools | |
3. Start an interactive chat session where you can: | |
- Enter queries | |
- See tool executions | |
- Get responses from Claude | |
## Key Components Explained | |
#### 1. Client Initialization | |
- The `MCPClient` class initializes with session management and API clients | |
- Sets up the MCP client with basic capabilities | |
- Configures the Anthropic client for Claude interactions | |
#### 2. Server Connection | |
- Supports both Python and Node.js servers | |
- Validates server script type | |
- Sets up proper communication channels | |
- Lists available tools on connection | |
#### 3. Query Processing | |
- Maintains conversation context | |
- Handles Claude's responses and tool calls | |
- Manages the message flow between Claude and tools | |
- Combines results into a coherent response | |
#### 4. Interactive Interface | |
- Provides a simple command-line interface | |
- Handles user input and displays responses | |
- Includes basic error handling | |
- Allows graceful exit | |
#### 5. Resource Management | |
- Proper cleanup of resources | |
- Error handling for connection issues | |
- Graceful shutdown procedures | |
### Common Customization Points | |
1. **Tool Handling** | |
- Modify `processQuery()` to handle specific tool types | |
- Add custom error handling for tool calls | |
- Implement tool-specific response formatting | |
2. **Response Processing** | |
- Customize how tool results are formatted | |
- Add response filtering or transformation | |
- Implement custom logging | |
3. **User Interface** | |
- Add a GUI or web interface | |
- Implement rich console output | |
- Add command history or auto-completion | |
### Best Practices | |
1. **Error Handling** | |
- Always wrap tool calls in try-catch blocks | |
- Provide meaningful error messages | |
- Gracefully handle connection issues | |
2. **Resource Management** | |
- Use proper cleanup methods | |
- Close connections when done | |
- Handle server disconnections | |
3. **Security** | |
- Store API keys securely in `.env` | |
- Validate server responses | |
- Be cautious with tool permissions | |
### Troubleshooting | |
#### Server Path Issues | |
- Double-check the path to your server script | |
- Use absolute paths if relative paths aren't working | |
- For Windows users, use forward slashes (/) or escaped backslashes (\\) | |
- Verify the server file has the correct extension (.py or .js) | |
Example of correct path usage: | |
```bash | |
# Relative path | |
node build/client.js ./server/weather.js | |
# Absolute path | |
node build/client.js /Users/username/projects/mcp-server/weather.js | |
# Windows path (either format works) | |
node build/client.js C:/projects/mcp-server/weather.js | |
node build/client.js C:\\projects\\mcp-server\\weather.js | |
``` | |
#### Connection Issues | |
- Verify the server script exists and has correct permissions | |
- Check that the server script is executable | |
- Ensure the server script's dependencies are installed | |
- Try running the server script directly to check for errors | |
#### Tool Execution Issues | |
- Check server logs for error messages | |
- Verify tool input arguments match the schema | |
- Ensure tool dependencies are available | |
- Add debug logging to track execution flow | |
</Tab> | |
// File: /Users/dennisonbertram/develop/docs/quickstart.mdx | |
--- | |
title: "Quickstart" | |
description: "Get started with building your first MCP server and connecting it to a host" | |
--- | |
In this tutorial, we'll build a simple MCP weather server and connect it to a host, Claude for Desktop. We'll start with a basic setup, and then progress to more complex use cases. | |
### What we'll be building | |
Many LLMs (including Claude) do not currently have the ability to fetch the forecast and severe weather alerts. Let's use MCP to solve that! | |
We'll build a server that exposes two tools: `get-alerts` and `get-forecast`. Then we'll connect the server to an MCP host (in this case, Claude for Desktop): | |
<Frame> | |
<img src="/images/weather-alerts.png" /> | |
</Frame> | |
<Frame> | |
<img src="/images/current-weather.png" /> | |
</Frame> | |
<Note> | |
Servers can connect to any client. We've chosen Claude for Desktop here for simplicity, but we also have guides on [building your own client](/tutorials/building-a-client) as well as a [list of other clients here](/clients). | |
</Note> | |
<Accordion title="Why Claude for Desktop and not Claude.ai?"> | |
Because servers are locally run, MCP currently only supports desktop hosts. Remote hosts are in active development. | |
</Accordion> | |
### Core MCP Concepts | |
MCP servers can provide three main types of capabilities: | |
1. **Resources**: File-like data that can be read by clients (like API responses or file contents) | |
2. **Tools**: Functions that can be called by the LLM (with user approval) | |
3. **Prompts**: Pre-written templates that help users accomplish specific tasks | |
This tutorial will primarily focus on tools. | |
<Tabs> | |
<Tab title='Python'> | |
Let's get started with building our weather server! [You can find the complete code for what we'll be building here.](https://github.com/modelcontextprotocol/quickstart-resources/tree/main/weather-server-python) | |
### Prerequisite knowledge | |
This quickstart assumes you have familiarity with: | |
- Python | |
- LLMs like Claude | |
### System requirements | |
For Python, make sure you have Python 3.9 or higher installed. | |
### Set up your environment | |
First, let's install `uv` and set up our Python project and environment: | |
<CodeGroup> | |
```bash MacOS/Linux | |
curl -LsSf https://astral.sh/uv/install.sh | sh | |
``` | |
```powershell Windows | |
powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex" | |
``` | |
</CodeGroup> | |
Make sure to restart your terminal afterwards to ensure that the `uv` command gets picked up. | |
Now, let's create and set up our project: | |
<CodeGroup> | |
```bash MacOS/Linux | |
# Create a new directory for our project | |
uv init weather | |
cd weather | |
# Create virtual environment and activate it | |
uv venv | |
source .venv/bin/activate | |
# Install dependencies | |
uv add mcp httpx | |
# Remove template file | |
rm hello.py | |
# Create our files | |
mkdir -p src/weather | |
touch src/weather/__init__.py | |
touch src/weather/server.py | |
``` | |
```powershell Windows | |
# 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 httpx | |
# Clean up boilerplate code | |
rm hello.py | |
# Create our files | |
md src | |
md src\weather | |
new-item src\weather\__init__.py | |
new-item src\weather\server.py | |
``` | |
</CodeGroup> | |
Add this code to `pyproject.toml`: | |
```toml | |
...rest of config | |
[build-system] | |
requires = [ "hatchling",] | |
build-backend = "hatchling.build" | |
[project.scripts] | |
weather = "weather:main" | |
``` | |
Add this code to `__init__.py`: | |
```python src/weather/__init__.py | |
from . import server | |
import asyncio | |
def main(): | |
"""Main entry point for the package.""" | |
asyncio.run(server.main()) | |
# Optionally expose other important items at package level | |
__all__ = ['main', 'server'] | |
``` | |
Now let's dive into building your server. | |
## Building your server | |
### Importing packages | |
Add these to the top of your `server.py`: | |
```python | |
from typing import Any | |
import asyncio | |
import httpx | |
from mcp.server.models import InitializationOptions | |
import mcp.types as types | |
from mcp.server import NotificationOptions, Server | |
import mcp.server.stdio | |
``` | |
### Setting up the instance | |
Then initialize the server instance and the base URL for the NWS API: | |
```python | |
NWS_API_BASE = "https://api.weather.gov" | |
USER_AGENT = "weather-app/1.0" | |
server = Server("weather") | |
``` | |
### Implementing tool listing | |
We need to tell clients what tools are available. The `list_tools()` decorator registers this handler: | |
```python | |
@server.list_tools() | |
async def handle_list_tools() -> list[types.Tool]: | |
""" | |
List available tools. | |
Each tool specifies its arguments using JSON Schema validation. | |
""" | |
return [ | |
types.Tool( | |
name="get-alerts", | |
description="Get weather alerts for a state", | |
inputSchema={ | |
"type": "object", | |
"properties": { | |
"state": { | |
"type": "string", | |
"description": "Two-letter state code (e.g. CA, NY)", | |
}, | |
}, | |
"required": ["state"], | |
}, | |
), | |
types.Tool( | |
name="get-forecast", | |
description="Get weather forecast for a location", | |
inputSchema={ | |
"type": "object", | |
"properties": { | |
"latitude": { | |
"type": "number", | |
"description": "Latitude of the location", | |
}, | |
"longitude": { | |
"type": "number", | |
"description": "Longitude of the location", | |
}, | |
}, | |
"required": ["latitude", "longitude"], | |
}, | |
), | |
] | |
``` | |
This defines our two tools: `get-alerts` and `get-forecast`. | |
### Helper functions | |
Next, let's add our helper functions for querying and formatting the data from the National Weather Service API: | |
```python | |
async def make_nws_request(client: httpx.AsyncClient, url: str) -> dict[str, Any] | None: | |
"""Make a request to the NWS API with proper error handling.""" | |
headers = { | |
"User-Agent": USER_AGENT, | |
"Accept": "application/geo+json" | |
} | |
try: | |
response = await client.get(url, headers=headers, timeout=30.0) | |
response.raise_for_status() | |
return response.json() | |
except Exception: | |
return None | |
def format_alert(feature: dict) -> str: | |
"""Format an alert feature into a concise string.""" | |
props = feature["properties"] | |
return ( | |
f"Event: {props.get('event', 'Unknown')}\n" | |
f"Area: {props.get('areaDesc', 'Unknown')}\n" | |
f"Severity: {props.get('severity', 'Unknown')}\n" | |
f"Status: {props.get('status', 'Unknown')}\n" | |
f"Headline: {props.get('headline', 'No headline')}\n" | |
"---" | |
) | |
``` | |
### Implementing tool execution | |
The tool execution handler is responsible for actually executing the logic of each tool. Let's add it: | |
```python | |
@server.call_tool() | |
async def handle_call_tool( | |
name: str, arguments: dict | None | |
) -> list[types.TextContent | types.ImageContent | types.EmbeddedResource]: | |
""" | |
Handle tool execution requests. | |
Tools can fetch weather data and notify clients of changes. | |
""" | |
if not arguments: | |
raise ValueError("Missing arguments") | |
if name == "get-alerts": | |
state = arguments.get("state") | |
if not state: | |
raise ValueError("Missing state parameter") | |
# Convert state to uppercase to ensure consistent format | |
state = state.upper() | |
if len(state) != 2: | |
raise ValueError("State must be a two-letter code (e.g. CA, NY)") | |
async with httpx.AsyncClient() as client: | |
alerts_url = f"{NWS_API_BASE}/alerts?area={state}" | |
alerts_data = await make_nws_request(client, alerts_url) | |
if not alerts_data: | |
return [types.TextContent(type="text", text="Failed to retrieve alerts data")] | |
features = alerts_data.get("features", []) | |
if not features: | |
return [types.TextContent(type="text", text=f"No active alerts for {state}")] | |
# Format each alert into a concise string | |
formatted_alerts = [format_alert(feature) for feature in features[:20]] # only take the first 20 alerts | |
alerts_text = f"Active alerts for {state}:\n\n" + "\n".join(formatted_alerts) | |
return [ | |
types.TextContent( | |
type="text", | |
text=alerts_text | |
) | |
] | |
elif name == "get-forecast": | |
try: | |
latitude = float(arguments.get("latitude")) | |
longitude = float(arguments.get("longitude")) | |
except (TypeError, ValueError): | |
return [types.TextContent( | |
type="text", | |
text="Invalid coordinates. Please provide valid numbers for latitude and longitude." | |
)] | |
# Basic coordinate validation | |
if not (-90 <= latitude <= 90) or not (-180 <= longitude <= 180): | |
return [types.TextContent( | |
type="text", | |
text="Invalid coordinates. Latitude must be between -90 and 90, longitude between -180 and 180." | |
)] | |
async with httpx.AsyncClient() as client: | |
# First get the grid point | |
lat_str = f"{latitude}" | |
lon_str = f"{longitude}" | |
points_url = f"{NWS_API_BASE}/points/{lat_str},{lon_str}" | |
points_data = await make_nws_request(client, points_url) | |
if not points_data: | |
return [types.TextContent(type="text", text=f"Failed to retrieve grid point data for coordinates: {latitude}, {longitude}. This location may not be supported by the NWS API (only US locations are supported).")] | |
# Extract forecast URL from the response | |
properties = points_data.get("properties", {}) | |
forecast_url = properties.get("forecast") | |
if not forecast_url: | |
return [types.TextContent(type="text", text="Failed to get forecast URL from grid point data")] | |
# Get the forecast | |
forecast_data = await make_nws_request(client, forecast_url) | |
if not forecast_data: | |
return [types.TextContent(type="text", text="Failed to retrieve forecast data")] | |
# Format the forecast periods | |
periods = forecast_data.get("properties", {}).get("periods", []) | |
if not periods: | |
return [types.TextContent(type="text", text="No forecast periods available")] | |
# Format each period into a concise string | |
formatted_forecast = [] | |
for period in periods: | |
forecast_text = ( | |
f"{period.get('name', 'Unknown')}:\n" | |
f"Temperature: {period.get('temperature', 'Unknown')}°{period.get('temperatureUnit', 'F')}\n" | |
f"Wind: {period.get('windSpeed', 'Unknown')} {period.get('windDirection', '')}\n" | |
f"{period.get('shortForecast', 'No forecast available')}\n" | |
"---" | |
) | |
formatted_forecast.append(forecast_text) | |
forecast_text = f"Forecast for {latitude}, {longitude}:\n\n" + "\n".join(formatted_forecast) | |
return [types.TextContent( | |
type="text", | |
text=forecast_text | |
)] | |
else: | |
raise ValueError(f"Unknown tool: {name}") | |
``` | |
### Running the server | |
Finally, implement the main function to run the server: | |
```python | |
async def main(): | |
# Run the server using stdin/stdout streams | |
async with mcp.server.stdio.stdio_server() as (read_stream, write_stream): | |
await server.run( | |
read_stream, | |
write_stream, | |
InitializationOptions( | |
server_name="weather", | |
server_version="0.1.0", | |
capabilities=server.get_capabilities( | |
notification_options=NotificationOptions(), | |
experimental_capabilities={}, | |
), | |
), | |
) | |
# This is needed if you'd like to connect to a custom client | |
if __name__ == "__main__": | |
asyncio.run(main()) | |
``` | |
Your server is complete! Run `uv run src/weather/server.py` to confirm that everything's working. | |
Let's now test your server from an existing MCP host, Claude for Desktop. | |
## Testing your server with Claude for Desktop | |
<Note> | |
Claude for Desktop is not yet available on Linux. Linux users can proceed to the [Building a client](/tutorials/building-a-client) tutorial to build an MCP client that connects to the server we just built. | |
</Note> | |
First, make sure you have Claude for Desktop installed. [You can install the latest version | |
here.](https://claude.ai/download) If you already have Claude for Desktop, **make sure it's updated to the latest version.** | |
We'll need to configure Claude for Desktop for whichever MCP servers you want to use. To do this, open your Claude for Desktop App configuration at `~/Library/Application Support/Claude/claude_desktop_config.json` in a text editor. Make sure to create the file if it doesn't exist. | |
For example, if you have [VS Code](https://code.visualstudio.com/) installed: | |
<Tabs> | |
<Tab title="MacOS/Linux"> | |
```bash | |
code ~/Library/Application\ Support/Claude/claude_desktop_config.json | |
``` | |
</Tab> | |
<Tab title="Windows"> | |
```powershell | |
code $env:AppData\Claude\claude_desktop_config.json | |
``` | |
</Tab> | |
</Tabs> | |
You'll then add your servers in the `mcpServers` key. The MCP UI elements will only show up in Claude for Desktop if at least one server is properly configured. | |
In this case, we'll add our single weather server like so: | |
<Tabs> | |
<Tab title="MacOS/Linux"> | |
```json Python | |
{ | |
"mcpServers": { | |
"weather": { | |
"command": "uv", | |
"args": [ | |
"--directory", | |
"/ABSOLUTE/PATH/TO/PARENT/FOLDER/weather", | |
"run", | |
"weather" | |
] | |
} | |
} | |
} | |
``` | |
</Tab> | |
<Tab title="Windows"> | |
```json Python | |
{ | |
"mcpServers": { | |
"weather": { | |
"command": "uv", | |
"args": [ | |
"--directory", | |
"C:\\ABSOLUTE\PATH\TO\PARENT\FOLDER\weather", | |
"run", | |
"weather" | |
] | |
} | |
} | |
} | |
``` | |
</Tab> | |
</Tabs> | |
<Note> | |
Make sure you pass in the absolute path to your server. | |
</Note> | |
This tells Claude for Desktop: | |
1. There's an MCP server named "weather" | |
2. To launch it by running `uv --directory /ABSOLUTE/PATH/TO/PARENT/FOLDER/weather run weather` | |
Save the file, and restart **Claude for Desktop**. | |
</Tab> | |
<Tab title="Node"> | |
Let's get started with building our weather server! [You can find the complete code for what we'll be building here.](https://github.com/modelcontextprotocol/quickstart-resources/tree/main/weather-server-typescript) | |
### Prerequisite knowledge | |
This quickstart assumes you have familiarity with: | |
- TypeScript | |
- LLMs like Claude | |
### System requirements | |
For TypeScript, make sure you have the latest version of Node installed. | |
### Set up your environment | |
First, let's install Node.js and npm if you haven't already. You can download them from [nodejs.org](https://nodejs.org/). | |
Verify your Node.js installation: | |
```bash | |
node --version | |
npm --version | |
``` | |
For this tutorial, you'll need Node.js version 16 or higher. | |
Now, let's create and set up our project: | |
<CodeGroup> | |
```bash MacOS/Linux | |
# Create a new directory for our project | |
mkdir weather | |
cd weather | |
# Initialize a new npm project | |
npm init -y | |
# Install dependencies | |
npm install @modelcontextprotocol/sdk zod | |
npm install -D @types/node typescript | |
# Create our files | |
mkdir src | |
touch src/index.ts | |
``` | |
```powershell Windows | |
# Create a new directory for our project | |
md weather | |
cd weather | |
# Initialize a new npm project | |
npm init -y | |
# Install dependencies | |
npm install @modelcontextprotocol/sdk zod | |
npm install -D @types/node typescript | |
# Create our files | |
md src | |
new-item src\index.ts | |
``` | |
</CodeGroup> | |
Update your package.json to add type: "module" and a build script: | |
```json package.json | |
{ | |
"type": "module", | |
"bin": { | |
"weather": "./build/index.js" | |
}, | |
"scripts": { | |
"build": "tsc && node -e \"require('fs').chmodSync('build/index.js', '755')\"", | |
}, | |
"files": [ | |
"build" | |
], | |
} | |
``` | |
Create a `tsconfig.json` in the root of your project: | |
```json tsconfig.json | |
{ | |
"compilerOptions": { | |
"target": "ES2022", | |
"module": "Node16", | |
"moduleResolution": "Node16", | |
"outDir": "./build", | |
"rootDir": "./src", | |
"strict": true, | |
"esModuleInterop": true, | |
"skipLibCheck": true, | |
"forceConsistentCasingInFileNames": true | |
}, | |
"include": ["src/**/*"], | |
"exclude": ["node_modules"] | |
} | |
``` | |
Now let's dive into building your server. | |
## Building your server | |
### Importing packages | |
Add these to the top of your `src/index.ts`: | |
```typescript | |
import { Server } from "@modelcontextprotocol/sdk/server/index.js"; | |
import { StdioServerTransport } from "@modelcontextprotocol/sdk/server/stdio.js"; | |
import { | |
CallToolRequestSchema, | |
ListToolsRequestSchema, | |
} from "@modelcontextprotocol/sdk/types.js"; | |
import { z } from "zod"; | |
``` | |
### Setting up the instance | |
Then initialize the NWS API base URL, validation schemas, and server instance: | |
```typescript | |
const NWS_API_BASE = "https://api.weather.gov"; | |
const USER_AGENT = "weather-app/1.0"; | |
// Define Zod schemas for validation | |
const AlertsArgumentsSchema = z.object({ | |
state: z.string().length(2), | |
}); | |
const ForecastArgumentsSchema = z.object({ | |
latitude: z.number().min(-90).max(90), | |
longitude: z.number().min(-180).max(180), | |
}); | |
// Create server instance | |
const server = new Server( | |
{ | |
name: "weather", | |
version: "1.0.0", | |
}, | |
{ | |
capabilities: { | |
tools: {}, | |
}, | |
} | |
); | |
``` | |
### Implementing tool listing | |
We need to tell clients what tools are available. This `server.setRequestHandler` call will register this list for us: | |
```typescript | |
// List available tools | |
server.setRequestHandler(ListToolsRequestSchema, async () => { | |
return { | |
tools: [ | |
{ | |
name: "get-alerts", | |
description: "Get weather alerts for a state", | |
inputSchema: { | |
type: "object", | |
properties: { | |
state: { | |
type: "string", | |
description: "Two-letter state code (e.g. CA, NY)", | |
}, | |
}, | |
required: ["state"], | |
}, | |
}, | |
{ | |
name: "get-forecast", | |
description: "Get weather forecast for a location", | |
inputSchema: { | |
type: "object", | |
properties: { | |
latitude: { | |
type: "number", | |
description: "Latitude of the location", | |
}, | |
longitude: { | |
type: "number", | |
description: "Longitude of the location", | |
}, | |
}, | |
required: ["latitude", "longitude"], | |
}, | |
}, | |
], | |
}; | |
}); | |
``` | |
This defines our two tools: `get-alerts` and `get-forecast`. | |
### Helper functions | |
Next, let's add our helper functions for querying and formatting the data from the National Weather Service API: | |
```typescript | |
// Helper function for making NWS API requests | |
async function makeNWSRequest<T>(url: string): Promise<T | null> { | |
const headers = { | |
"User-Agent": USER_AGENT, | |
Accept: "application/geo+json", | |
}; | |
try { | |
const response = await fetch(url, { headers }); | |
if (!response.ok) { | |
throw new Error(`HTTP error! status: ${response.status}`); | |
} | |
return (await response.json()) as T; | |
} catch (error) { | |
console.error("Error making NWS request:", error); | |
return null; | |
} | |
} | |
interface AlertFeature { | |
properties: { | |
event?: string; | |
areaDesc?: string; | |
severity?: string; | |
status?: string; | |
headline?: string; | |
}; | |
} | |
// Format alert data | |
function formatAlert(feature: AlertFeature): string { | |
const props = feature.properties; | |
return [ | |
`Event: ${props.event || "Unknown"}`, | |
`Area: ${props.areaDesc || "Unknown"}`, | |
`Severity: ${props.severity || "Unknown"}`, | |
`Status: ${props.status || "Unknown"}`, | |
`Headline: ${props.headline || "No headline"}`, | |
"---", | |
].join("\n"); | |
} | |
interface ForecastPeriod { | |
name?: string; | |
temperature?: number; | |
temperatureUnit?: string; | |
windSpeed?: string; | |
windDirection?: string; | |
shortForecast?: string; | |
} | |
interface AlertsResponse { | |
features: AlertFeature[]; | |
} | |
interface PointsResponse { | |
properties: { | |
forecast?: string; | |
}; | |
} | |
interface ForecastResponse { | |
properties: { | |
periods: ForecastPeriod[]; | |
}; | |
} | |
``` | |
### Implementing tool execution | |
The tool execution handler is responsible for actually executing the logic of each tool. Let's add it: | |
```typescript | |
// Handle tool execution | |
server.setRequestHandler(CallToolRequestSchema, async (request) => { | |
const { name, arguments: args } = request.params; | |
try { | |
if (name === "get-alerts") { | |
const { state } = AlertsArgumentsSchema.parse(args); | |
const stateCode = state.toUpperCase(); | |
const alertsUrl = `${NWS_API_BASE}/alerts?area=${stateCode}`; | |
const alertsData = await makeNWSRequest<AlertsResponse>(alertsUrl); | |
if (!alertsData) { | |
return { | |
content: [ | |
{ | |
type: "text", | |
text: "Failed to retrieve alerts data", | |
}, | |
], | |
}; | |
} | |
const features = alertsData.features || []; | |
if (features.length === 0) { | |
return { | |
content: [ | |
{ | |
type: "text", | |
text: `No active alerts for ${stateCode}`, | |
}, | |
], | |
}; | |
} | |
const formattedAlerts = features.map(formatAlert).slice(0, 20) // only take the first 20 alerts; | |
const alertsText = `Active alerts for ${stateCode}:\n\n${formattedAlerts.join( | |
"\n" | |
)}`; | |
return { | |
content: [ | |
{ | |
type: "text", | |
text: alertsText, | |
}, | |
], | |
}; | |
} else if (name === "get-forecast") { | |
const { latitude, longitude } = ForecastArgumentsSchema.parse(args); | |
// Get grid point data | |
const pointsUrl = `${NWS_API_BASE}/points/${latitude.toFixed( | |
4 | |
)},${longitude.toFixed(4)}`; | |
const pointsData = await makeNWSRequest<PointsResponse>(pointsUrl); | |
if (!pointsData) { | |
return { | |
content: [ | |
{ | |
type: "text", | |
text: `Failed to retrieve grid point data for coordinates: ${latitude}, ${longitude}. This location may not be supported by the NWS API (only US locations are supported).`, | |
}, | |
], | |
}; | |
} | |
const forecastUrl = pointsData.properties?.forecast; | |
if (!forecastUrl) { | |
return { | |
content: [ | |
{ | |
type: "text", | |
text: "Failed to get forecast URL from grid point data", | |
}, | |
], | |
}; | |
} | |
// Get forecast data | |
const forecastData = await makeNWSRequest<ForecastResponse>(forecastUrl); | |
if (!forecastData) { | |
return { | |
content: [ | |
{ | |
type: "text", | |
text: "Failed to retrieve forecast data", | |
}, | |
], | |
}; | |
} | |
const periods = forecastData.properties?.periods || []; | |
if (periods.length === 0) { | |
return { | |
content: [ | |
{ | |
type: "text", | |
text: "No forecast periods available", | |
}, | |
], | |
}; | |
} | |
// Format forecast periods | |
const formattedForecast = periods.map((period: ForecastPeriod) => | |
[ | |
`${period.name || "Unknown"}:`, | |
`Temperature: ${period.temperature || "Unknown"}°${ | |
period.temperatureUnit || "F" | |
}`, | |
`Wind: ${period.windSpeed || "Unknown"} ${ | |
period.windDirection || "" | |
}`, | |
`${period.shortForecast || "No forecast available"}`, | |
"---", | |
].join("\n") | |
); | |
const forecastText = `Forecast for ${latitude}, ${longitude}:\n\n${formattedForecast.join( | |
"\n" | |
)}`; | |
return { | |
content: [ | |
{ | |
type: "text", | |
text: forecastText, | |
}, | |
], | |
}; | |
} else { | |
throw new Error(`Unknown tool: ${name}`); | |
} | |
} catch (error) { | |
if (error instanceof z.ZodError) { | |
throw new Error( | |
`Invalid arguments: ${error.errors | |
.map((e) => `${e.path.join(".")}: ${e.message}`) | |
.join(", ")}` | |
); | |
} | |
throw error; | |
} | |
}); | |
``` | |
### Running the server | |
Finally, implement the main function to run the server: | |
```typescript | |
// Start the server | |
async function main() { | |
const transport = new StdioServerTransport(); | |
await server.connect(transport); | |
console.error("Weather MCP Server running on stdio"); | |
} | |
main().catch((error) => { | |
console.error("Fatal error in main():", error); | |
process.exit(1); | |
}); | |
``` | |
Make sure to run `npm run build` to build your server! This is a very important step in getting your server to connect. | |
Let's now test your server from an existing MCP host, Claude for Desktop. | |
## Testing your server with Claude for Desktop | |
<Note> | |
Claude for Desktop is not yet available on Linux. Linux users can proceed to the [Building a client](/tutorials/building-a-client) tutorial to build an MCP client that connects to the server we just built. | |
</Note> | |
First, make sure you have Claude for Desktop installed. [You can install the latest version | |
here.](https://claude.ai/download) If you already have Claude for Desktop, **make sure it's updated to the latest version.** | |
We'll need to configure Claude for Desktop for whichever MCP servers you want to use. To do this, open your Claude for Desktop App configuration at `~/Library/Application Support/Claude/claude_desktop_config.json` in a text editor. Make sure to create the file if it doesn't exist. | |
For example, if you have [VS Code](https://code.visualstudio.com/) installed: | |
<Tabs> | |
<Tab title="MacOS/Linux"> | |
```bash | |
code ~/Library/Application\ Support/Claude/claude_desktop_config.json | |
``` | |
</Tab> | |
<Tab title="Windows"> | |
```powershell | |
code $env:AppData\Claude\claude_desktop_config.json | |
``` | |
</Tab> | |
</Tabs> | |
You'll then add your servers in the `mcpServers` key. The MCP UI elements will only show up in Claude for Desktop if at least one server is properly configured. | |
In this case, we'll add our single weather server like so: | |
<Tabs> | |
<Tab title="MacOS/Linux"> | |
<CodeGroup> | |
```json Node | |
{ | |
"mcpServers": { | |
"weather": { | |
"command": "node", | |
"args": [ | |
"/ABSOLUTE/PATH/TO/PARENT/FOLDER/weather/build/index.js" | |
] | |
} | |
} | |
} | |
``` | |
</CodeGroup> | |
</Tab> | |
<Tab title="Windows"> | |
<CodeGroup> | |
```json Node | |
{ | |
"mcpServers": { | |
"weather": { | |
"command": "node", | |
"args": [ | |
"C:\\PATH\TO\PARENT\FOLDER\weather\build\index.js" | |
] | |
} | |
} | |
} | |
``` | |
</CodeGroup> | |
</Tab> | |
</Tabs> | |
This tells Claude for Desktop: | |
1. There's an MCP server named "weather" | |
2. Launch it by running `node /ABSOLUTE/PATH/TO/PARENT/FOLDER/weather/build/index.js` | |
Save the file, and restart **Claude for Desktop**. | |
</Tab> | |
</Tabs> | |
### Test with commands | |
Let's make sure Claude for Desktop is picking up the two tools we've exposed in our `weather` server. You can do this by looking for the hammer <img src="/images/claude-desktop-mcp-hammer-icon.svg" style={{display: 'inline', margin: 0, height: '1.3em'}} /> icon: | |
<Frame> | |
<img src="/images/visual-indicator-mcp-tools.png" /> | |
</Frame> | |
After clicking on the hammer icon, you should see two tools listed: | |
<Frame> | |
<img src="/images/available-mcp-tools.png" /> | |
</Frame> | |
If your server isn't being picked up by Claude for Desktop, proceed to the [Troubleshooting](#troubleshooting) section for debugging tips. | |
If the hammer icon has shown up, you can now test your server by running the following commands in Claude for Desktop: | |
- What's the weather in Sacramento? | |
- What are the active weather alerts in Texas? | |
<Frame> | |
<img src="/images/current-weather.png" /> | |
</Frame> | |
<Frame> | |
<img src="/images/weather-alerts.png" /> | |
</Frame> | |
<Note> | |
Since this is the US National Weather service, the queries will only work for US locations. | |
</Note> | |
## What's happening under the hood | |
When you ask a question: | |
1. The client sends your question to Claude | |
2. Claude analyzes the available tools and decides which one(s) to use | |
3. The client executes the chosen tool(s) through the MCP server | |
4. The results are sent back to Claude | |
5. Claude formulates a natural language response | |
6. The response is displayed to you! | |
## Troubleshooting | |
<AccordionGroup> | |
<Accordion title="Claude for Desktop Integration Issues"> | |
**Getting logs from Claude for Desktop** | |
Claude.app logging related to MCP is written to log files in `~/Library/Logs/Claude`: | |
- `mcp.log` will contain general logging about MCP connections and connection failures. | |
- Files named `mcp-server-SERVERNAME.log` will contain error (stderr) logging from the named server. | |
You can run the following command to list recent logs and follow along with any new ones: | |
```bash | |
# Check Claude's logs for errors | |
tail -n 20 -f ~/Library/Logs/Claude/mcp*.log | |
``` | |
**Server not showing up in Claude** | |
1. Check your `desktop_config.json` file syntax | |
2. Make sure the path to your project is absolute and not relative | |
3. Restart Claude for Desktop completely | |
**Tool calls failing silently** | |
If Claude attempts to use the tools but they fail: | |
1. Check Claude's logs for errors | |
2. Verify your server builds and runs without errors | |
3. Try restarting Claude for Desktop | |
**None of this is working. What do I do?** | |
Please refer to our [debugging guide](/docs/tools/debugging) for better debugging tools and more detailed guidance. | |
</Accordion> | |
<Accordion title="Weather API Issues"> | |
**Error: Failed to retrieve grid point data** | |
This usually means either: | |
1. The coordinates are outside the US | |
2. The NWS API is having issues | |
3. You're being rate limited | |
Fix: | |
- Verify you're using US coordinates | |
- Add a small delay between requests | |
- Check the NWS API status page | |
**Error: No active alerts for [STATE]** | |
This isn't an error - it just means there are no current weather alerts for that state. Try a different state or check during severe weather. | |
</Accordion> | |
</AccordionGroup> | |
<Note> | |
For more advanced troubleshooting, check out our guide on [Debugging MCP](/docs/tools/debugging) | |
</Note> | |
## Next steps | |
<CardGroup cols={2}> | |
<Card | |
title="Building a client" | |
icon="outlet" | |
href="/tutorials/building-a-client" | |
> | |
Learn how to build your an MCP client that can connect to your server | |
</Card> | |
<Card | |
title="Example servers" | |
icon="grid" | |
href="/examples" | |
> | |
Check out our gallery of official MCP servers and implementations | |
</Card> | |
<Card | |
title="Debugging Guide" | |
icon="bug" | |
href="/docs/tools/debugging"> | |
Learn how to effectively debug MCP servers and integrations | |
</Card> | |
<Card | |
title="Building MCP with LLMs" | |
icon="comments" | |
href="/building-mcp-with-llms" | |
> | |
Learn how to use LLMs like Claude to speed up your MCP development | |
</Card> | |
</CardGroup> |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment