From 261c566d490cbf7938662f210fb3a5e4f8d07553 Mon Sep 17 00:00:00 2001 From: Justin Spahr-Summers Date: Mon, 18 Nov 2024 13:16:48 +0000 Subject: [PATCH] Basic README --- README.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/README.md b/README.md index 2e8b6b9..fd9880c 100644 --- a/README.md +++ b/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.