create-typescript-server/README.md
2024-11-18 15:31:11 +00:00

31 lines
867 B
Markdown

# create-typescript-server ![NPM Version](https://img.shields.io/npm/v/%40modelcontextprotocol%2Fcreate-server)
A command line tool for quickly scaffolding new MCP (Model Context Protocol) servers.
## Getting Started
```bash
# Create a new server in the directory `my-server`
npx @modelcontextprotocol/create-server my-server
# With options
npx @modelcontextprotocol/create-server my-server --name "My MCP Server" --description "A custom MCP server"
```
After creating your server:
```bash
cd my-server # Navigate to server directory
npm install # Install dependencies
npm run build # Build once
# or...
npm run watch # Start TypeScript compiler in watch mode
# optional
npm link # Make your server binary globally available
```
## License
This project is licensed under the MIT License—see the [LICENSE](LICENSE) file for details.