Merge pull request #115 from modelcontextprotocol/justin/simplified-ts-sdk
Update TypeScript examples to use simplified API
This commit is contained in:
Justin Spahr-Summers
GitHub
commit
eb871954bb
5 changed files with 141 additions and 251 deletions
|
|
@ -210,35 +210,30 @@ Here's a basic example of implementing an MCP server:
|
|||
|
||||
<Tabs>
|
||||
<Tab title="TypeScript">
|
||||
```typescript
|
||||
import { Server } from "@modelcontextprotocol/sdk/server/index.js";
|
||||
import { StdioServerTransport } from "@modelcontextprotocol/sdk/server/stdio.js";
|
||||
|
||||
const server = new Server({
|
||||
name: "example-server",
|
||||
version: "1.0.0"
|
||||
}, {
|
||||
capabilities: {
|
||||
resources: {}
|
||||
}
|
||||
});
|
||||
|
||||
// Handle requests
|
||||
server.setRequestHandler(ListResourcesRequestSchema, async () => {
|
||||
return {
|
||||
resources: [
|
||||
{
|
||||
uri: "example://resource",
|
||||
name: "Example Resource"
|
||||
}
|
||||
]
|
||||
};
|
||||
});
|
||||
|
||||
// Connect transport
|
||||
const transport = new StdioServerTransport();
|
||||
await server.connect(transport);
|
||||
```
|
||||
```typescript
|
||||
import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
|
||||
|
||||
const server = new McpServer({
|
||||
name: "example-server",
|
||||
version: "1.0.0"
|
||||
});
|
||||
|
||||
// Register a resource
|
||||
server.resource(
|
||||
"example",
|
||||
"example://resource",
|
||||
async (uri) => ({
|
||||
contents: [{
|
||||
uri: uri.href,
|
||||
text: "Example resource content"
|
||||
}]
|
||||
})
|
||||
);
|
||||
|
||||
// Connect transport
|
||||
const transport = new StdioServerTransport();
|
||||
await server.connect(transport);
|
||||
```
|
||||
</Tab>
|
||||
<Tab title="Python">
|
||||
```python
|
||||
|
|
|
|||
|
|
@ -197,98 +197,52 @@ Here's a complete example of implementing prompts in an MCP server:
|
|||
|
||||
<Tabs>
|
||||
<Tab title="TypeScript">
|
||||
```typescript
|
||||
import { Server } from "@modelcontextprotocol/sdk/server";
|
||||
import {
|
||||
ListPromptsRequestSchema,
|
||||
GetPromptRequestSchema
|
||||
} from "@modelcontextprotocol/sdk/types";
|
||||
|
||||
const PROMPTS = {
|
||||
"git-commit": {
|
||||
name: "git-commit",
|
||||
description: "Generate a Git commit message",
|
||||
arguments: [
|
||||
{
|
||||
name: "changes",
|
||||
description: "Git diff or description of changes",
|
||||
required: true
|
||||
}
|
||||
]
|
||||
},
|
||||
"explain-code": {
|
||||
name: "explain-code",
|
||||
description: "Explain how code works",
|
||||
arguments: [
|
||||
{
|
||||
name: "code",
|
||||
description: "Code to explain",
|
||||
required: true
|
||||
},
|
||||
{
|
||||
name: "language",
|
||||
description: "Programming language",
|
||||
required: false
|
||||
}
|
||||
]
|
||||
}
|
||||
};
|
||||
|
||||
const server = new Server({
|
||||
name: "example-prompts-server",
|
||||
version: "1.0.0"
|
||||
}, {
|
||||
capabilities: {
|
||||
prompts: {}
|
||||
}
|
||||
});
|
||||
|
||||
// List available prompts
|
||||
server.setRequestHandler(ListPromptsRequestSchema, async () => {
|
||||
return {
|
||||
prompts: Object.values(PROMPTS)
|
||||
};
|
||||
});
|
||||
|
||||
// Get specific prompt
|
||||
server.setRequestHandler(GetPromptRequestSchema, async (request) => {
|
||||
const prompt = PROMPTS[request.params.name];
|
||||
if (!prompt) {
|
||||
throw new Error(`Prompt not found: ${request.params.name}`);
|
||||
}
|
||||
|
||||
if (request.params.name === "git-commit") {
|
||||
return {
|
||||
messages: [
|
||||
{
|
||||
role: "user",
|
||||
content: {
|
||||
type: "text",
|
||||
text: `Generate a concise but descriptive commit message for these changes:\n\n${request.params.arguments?.changes}`
|
||||
}
|
||||
}
|
||||
]
|
||||
};
|
||||
}
|
||||
|
||||
if (request.params.name === "explain-code") {
|
||||
const language = request.params.arguments?.language || "Unknown";
|
||||
return {
|
||||
messages: [
|
||||
{
|
||||
role: "user",
|
||||
content: {
|
||||
type: "text",
|
||||
text: `Explain how this ${language} code works:\n\n${request.params.arguments?.code}`
|
||||
}
|
||||
}
|
||||
]
|
||||
};
|
||||
}
|
||||
|
||||
throw new Error("Prompt implementation not found");
|
||||
});
|
||||
```
|
||||
```typescript
|
||||
import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
|
||||
import { z } from "zod";
|
||||
|
||||
const server = new McpServer({
|
||||
name: "example-prompts-server",
|
||||
version: "1.0.0"
|
||||
});
|
||||
|
||||
// Register git commit prompt
|
||||
server.prompt(
|
||||
"git-commit",
|
||||
"Generate a Git commit message",
|
||||
{
|
||||
changes: z.string().describe("Git diff or description of changes")
|
||||
},
|
||||
({ changes }) => ({
|
||||
messages: [{
|
||||
role: "user",
|
||||
content: {
|
||||
type: "text",
|
||||
text: `Generate a concise but descriptive commit message for these changes:\n\n${changes}`
|
||||
}
|
||||
}]
|
||||
})
|
||||
);
|
||||
|
||||
// Register code explanation prompt
|
||||
server.prompt(
|
||||
"explain-code",
|
||||
"Explain how code works",
|
||||
{
|
||||
code: z.string().describe("Code to explain"),
|
||||
language: z.string().optional().describe("Programming language")
|
||||
},
|
||||
({ code, language }) => ({
|
||||
messages: [{
|
||||
role: "user",
|
||||
content: {
|
||||
type: "text",
|
||||
text: `Explain how this ${language || "Unknown"} code works:\n\n${code}`
|
||||
}
|
||||
}]
|
||||
})
|
||||
);
|
||||
```
|
||||
</Tab>
|
||||
<Tab title="Python">
|
||||
```python
|
||||
|
|
|
|||
|
|
@ -145,47 +145,32 @@ Here's a simple example of implementing resource support in an MCP server:
|
|||
<Tabs>
|
||||
<Tab title="TypeScript">
|
||||
```typescript
|
||||
const server = new Server({
|
||||
import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
|
||||
|
||||
const server = new McpServer({
|
||||
name: "example-server",
|
||||
version: "1.0.0"
|
||||
}, {
|
||||
capabilities: {
|
||||
resources: {}
|
||||
}
|
||||
});
|
||||
|
||||
// List available resources
|
||||
server.setRequestHandler(ListResourcesRequestSchema, async () => {
|
||||
return {
|
||||
resources: [
|
||||
{
|
||||
uri: "file:///logs/app.log",
|
||||
name: "Application Logs",
|
||||
mimeType: "text/plain"
|
||||
}
|
||||
]
|
||||
};
|
||||
});
|
||||
|
||||
// Read resource contents
|
||||
server.setRequestHandler(ReadResourceRequestSchema, async (request) => {
|
||||
const uri = request.params.uri;
|
||||
|
||||
if (uri === "file:///logs/app.log") {
|
||||
// Add static resource
|
||||
server.resource(
|
||||
"logs",
|
||||
"file:///logs/app.log",
|
||||
{
|
||||
mimeType: "text/plain",
|
||||
description: "Application log file"
|
||||
},
|
||||
async (uri) => {
|
||||
const logContents = await readLogFile();
|
||||
return {
|
||||
contents: [
|
||||
{
|
||||
uri,
|
||||
mimeType: "text/plain",
|
||||
text: logContents
|
||||
}
|
||||
]
|
||||
contents: [{
|
||||
uri: uri.href,
|
||||
mimeType: "text/plain",
|
||||
text: logContents
|
||||
}]
|
||||
};
|
||||
}
|
||||
|
||||
throw new Error("Resource not found");
|
||||
});
|
||||
);
|
||||
```
|
||||
</Tab>
|
||||
<Tab title="Python">
|
||||
|
|
|
|||
|
|
@ -40,50 +40,31 @@ Here's an example of implementing a basic tool in an MCP server:
|
|||
|
||||
<Tabs>
|
||||
<Tab title="TypeScript">
|
||||
```typescript
|
||||
const server = new Server({
|
||||
name: "example-server",
|
||||
version: "1.0.0"
|
||||
}, {
|
||||
capabilities: {
|
||||
tools: {}
|
||||
}
|
||||
});
|
||||
|
||||
// Define available tools
|
||||
server.setRequestHandler(ListToolsRequestSchema, async () => {
|
||||
return {
|
||||
tools: [{
|
||||
name: "calculate_sum",
|
||||
description: "Add two numbers together",
|
||||
inputSchema: {
|
||||
type: "object",
|
||||
properties: {
|
||||
a: { type: "number" },
|
||||
b: { type: "number" }
|
||||
},
|
||||
required: ["a", "b"]
|
||||
}
|
||||
}]
|
||||
};
|
||||
});
|
||||
|
||||
// Handle tool execution
|
||||
server.setRequestHandler(CallToolRequestSchema, async (request) => {
|
||||
if (request.params.name === "calculate_sum") {
|
||||
const { a, b } = request.params.arguments;
|
||||
return {
|
||||
content: [
|
||||
{
|
||||
type: "text",
|
||||
text: String(a + b)
|
||||
}
|
||||
]
|
||||
};
|
||||
}
|
||||
throw new Error("Tool not found");
|
||||
});
|
||||
```
|
||||
```typescript
|
||||
import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
|
||||
import { z } from "zod";
|
||||
|
||||
const server = new McpServer({
|
||||
name: "example-server",
|
||||
version: "1.0.0"
|
||||
});
|
||||
|
||||
// Register a tool
|
||||
server.tool(
|
||||
"calculate_sum",
|
||||
"Add two numbers together",
|
||||
{
|
||||
a: z.number(),
|
||||
b: z.number()
|
||||
},
|
||||
async ({ a, b }) => ({
|
||||
content: [{
|
||||
type: "text",
|
||||
text: String(a + b)
|
||||
}]
|
||||
})
|
||||
);
|
||||
```
|
||||
</Tab>
|
||||
<Tab title="Python">
|
||||
```python
|
||||
|
|
|
|||
|
|
@ -450,64 +450,39 @@ const ForecastArgumentsSchema = z.object({
|
|||
longitude: z.number().min(-180).max(180),
|
||||
});
|
||||
|
||||
// Create server instance
|
||||
const server = new Server(
|
||||
```typescript
|
||||
import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
|
||||
import { z } from "zod";
|
||||
|
||||
const server = new McpServer({
|
||||
name: "weather",
|
||||
version: "1.0.0"
|
||||
});
|
||||
|
||||
// Register weather alert tool
|
||||
server.tool(
|
||||
"get-alerts",
|
||||
"Get weather alerts for a state",
|
||||
{
|
||||
name: "weather",
|
||||
version: "1.0.0",
|
||||
state: z.string().length(2).describe("Two-letter state code (e.g. CA, NY)")
|
||||
},
|
||||
{
|
||||
capabilities: {
|
||||
tools: {},
|
||||
},
|
||||
async ({ state }) => {
|
||||
// Tool implementation
|
||||
}
|
||||
);
|
||||
```
|
||||
|
||||
### 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"],
|
||||
},
|
||||
},
|
||||
],
|
||||
};
|
||||
});
|
||||
// Register forecast tool
|
||||
server.tool(
|
||||
"get-forecast",
|
||||
"Get weather forecast for a location",
|
||||
{
|
||||
latitude: z.number().min(-90).max(90).describe("Latitude of the location"),
|
||||
longitude: z.number().min(-180).max(180).describe("Longitude of the location")
|
||||
},
|
||||
async ({ latitude, longitude }) => {
|
||||
// Tool implementation
|
||||
}
|
||||
);
|
||||
```
|
||||
|
||||
This defines our two tools: `get-alerts` and `get-forecast`.
|
||||
|
|
|
|||
Loading…
Reference in a new issue