Basic README
This commit is contained in:
parent
0c5b091517
commit
261c566d49
1 changed files with 23 additions and 0 deletions
23
README.md
23
README.md
|
|
@ -1,5 +1,28 @@
|
|||
# create-typescript-server
|
||||
|
||||
A command line tool for quickly scaffolding new MCP (Model Context Protocol) servers.
|
||||
|
||||
## Getting Started
|
||||
|
||||
```bash
|
||||
# Create a new server in the current directory
|
||||
npx @modelcontextprotocol/create-server
|
||||
|
||||
# Or specify a directory
|
||||
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 dev # Start TypeScript compiler in watch mode
|
||||
```
|
||||
|
||||
## License
|
||||
|
||||
This project is licensed under the MIT License—see the [LICENSE](LICENSE) file for details.
|
||||
|
|
|
|||
Loading…
Reference in a new issue