Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

More README improvements #136

Merged
merged 2 commits into from
Jan 23, 2025
Merged

More README improvements #136

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6896e57
Add transport to quickstart too
jspahrsummers Jan 23, 2025
e72314c
Make clear where server handlers go in "Running Your Server"
jspahrsummers Jan 23, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 11 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@ Let's create a simple MCP server that exposes a calculator tool and some data:

```typescript
import { McpServer, ResourceTemplate } from "@modelcontextprotocol/sdk/server/mcp.js";
import { StdioServerTransport } from "@modelcontextprotocol/sdk/server/stdio.js";
import { z } from "zod";

// Create an MCP server
Expand Down Expand Up @@ -70,6 +71,10 @@ server.resource(
}]
})
);

// Start receiving messages on stdin and sending messages on stdout
const transport = new StdioServerTransport();
await server.connect(transport);
Comment on lines +75 to +77
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

h/t @jasonkneen for highlighting that this is missing

```

## What is MCP?
Expand Down Expand Up @@ -195,6 +200,8 @@ const server = new McpServer({
version: "1.0.0"
});

// ... set up server resources, tools, and prompts ...

const transport = new StdioServerTransport();
await server.connect(transport);
```
Expand All @@ -208,12 +215,15 @@ import express from "express";
import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
import { SSEServerTransport } from "@modelcontextprotocol/sdk/server/sse.js";

const app = express();
const server = new McpServer({
name: "example-server",
version: "1.0.0"
});

// ... set up server resources, tools, and prompts ...

const app = express();

app.get("/mcp", async (req, res) => {
const transport = new SSEServerTransport("/messages", res);
await server.connect(transport);
Expand Down
Loading