modelcontextprotocol/docs
Watch
1
0
Fork
You've already forked docs
 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Use @modelcontextprotocol/create-server

Browse source
This commit is contained in:
Justin Spahr-Summers 2024-11-21 13:22:16 +00:00
commit 1e5dc3398e
No known key found for this signature in database
1 changed files with 8 additions and 46 deletions
Download patch file Download diff file Expand all files Collapse all files

54
docs/first-server/typescript.mdx
View file

@ -22,35 +22,17 @@ This guide uses the OpenWeatherMap API. You'll need a free API key from [OpenWea
</Step> </Step>
<Step title="Create a new project"> <Step title="Create a new project">
You can use our [create-typescript-server](https://github.com/modelcontextprotocol/create-typescript-server) tool to bootstrap a new project:
```bash ```bash
mkdir weather-server npx @modelcontextprotocol/create-server weather-server
cd weather-server cd weather-server
npm init -y
``` ```
</Step> </Step>
<Step title="Install dependencies"> <Step title="Install dependencies">
```bash ```bash
npm install @modelcontextprotocol/sdk axios dotenv typescript @types/node npm install --save axios dotenv
npm install --save-dev ts-node
```
</Step>
<Step title="Configure TypeScript">
Create `tsconfig.json`:
```json
{
"compilerOptions": {
"target": "ES2020",
"module": "ES2020",
"moduleResolution": "node",
"esModuleInterop": true,
"outDir": "./dist",
"rootDir": "./src",
"strict": true
},
"include": ["src/**/*"]
}
``` ```
</Step> </Step>
@ -65,16 +47,8 @@ This guide uses the OpenWeatherMap API. You'll need a free API key from [OpenWea
## Create your server ## Create your server
<Steps> <Steps>
<Step title="Create project structure">
```bash
mkdir src
touch src/index.ts
touch src/types.ts
```
</Step>
<Step title="Define types"> <Step title="Define types">
In `src/types.ts`: Create a file `types.ts`, and add the following:
```typescript ```typescript
export interface OpenWeatherResponse { export interface OpenWeatherResponse {
@ -124,7 +98,7 @@ This guide uses the OpenWeatherMap API. You'll need a free API key from [OpenWea
</Step> </Step>
<Step title="Add the base code"> <Step title="Add the base code">
In `src/index.ts`: Replace `index.ts` with the following:
```typescript ```typescript
import { Server } from "@modelcontextprotocol/sdk/server/index.js"; import { Server } from "@modelcontextprotocol/sdk/server/index.js";
@ -376,21 +350,9 @@ This guide uses the OpenWeatherMap API. You'll need a free API key from [OpenWea
</Step> </Step>
<Step title="Build and test"> <Step title="Build and test">
Add these scripts to `package.json`:
```json
{
"scripts": {
"build": "tsc",
"start": "node dist/index.js",
"dev": "ts-node src/index.ts"
}
}
```
Then run:
```bash ```bash
npm run build npm run build
npm install -g . npm link
``` ```
</Step> </Step>
</Steps> </Steps>
@ -628,4 +590,4 @@ npx tsc --noEmit
<Note> <Note>
Need help? Ask Claude! Since it has access to the MCP SDK documentation, it can help you debug issues and suggest improvements to your server. Need help? Ask Claude! Since it has access to the MCP SDK documentation, it can help you debug issues and suggest improvements to your server.
</Note> </Note>