Skip to content

Commit 55c68a4

Browse files
committed
refactor: rename package to @mcpdotdirect/template-mcp-server and update README for user quickstart
1 parent 830655c commit 55c68a4

2 files changed

Lines changed: 38 additions & 11 deletions

File tree

README.md

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,21 @@
1-
# @mcpdotdirect/create-mcp-server
1+
# @mcpdotdirect/template-mcp-server
22

33
![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)
44
![TypeScript](https://img.shields.io/badge/TypeScript-5.0+-3178C6)
55
![MCP](https://img.shields.io/badge/MCP-1.7+-green)
66

7-
A CLI tool to create a new Model Context Protocol (MCP) server project. This package provides a template for building custom MCP servers that can be used by AI agents to interact with external systems and data sources.
7+
A CLI tool to quickly get started building your very own MCP (Model Context Protocol) server.
88

99
## 📋 Usage
1010

11-
You can create a new MCP server project using npx:
12-
1311
```bash
14-
# Create a new MCP server in the current directory
12+
# with npx
1513
npx @mcpdotdirect/create-mcp-server
1614

1715
# Or with npm
1816
npm init @mcpdotdirect/create-mcp-server
1917
```
2018

21-
This will create a new MCP server project in the current directory with all the necessary files. You'll need to install the dependencies manually after creation.
22-
2319
## 🔭 What's Included
2420

2521
The template includes:

package.json

Lines changed: 35 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,49 @@
11
{
2-
"name": "mcp-server",
2+
"name": "@mcpdotdirect/create-mcp-server",
33
"module": "src/index.ts",
44
"type": "module",
55
"version": "1.0.0",
6-
"description": "Model Context Protocol (MCP) Server",
7-
"private": true,
6+
"description": "Model Context Protocol (MCP) Server Template Generator",
7+
"private": false,
8+
"main": "build/index.js",
9+
"bin": {
10+
"create-mcp-server": "build/index.js"
11+
},
12+
"files": [
13+
"build",
14+
"LICENSE",
15+
"README.md"
16+
],
817
"scripts": {
918
"start": "bun run src/index.ts",
1019
"build": "bun build src/index.ts --outdir build --target node",
1120
"build:http": "bun build src/server/http-server.ts --outdir build --target node",
1221
"dev": "bun --watch src/index.ts",
1322
"start:http": "bun run src/server/http-server.ts",
14-
"dev:http": "bun --watch src/server/http-server.ts"
23+
"dev:http": "bun --watch src/server/http-server.ts",
24+
"prepublishOnly": "bun run build"
25+
},
26+
"repository": {
27+
"type": "git",
28+
"url": "git+https://github.com/mcpdotdirect/template-mcp-server.git"
29+
},
30+
"publishConfig": {
31+
"access": "public"
32+
},
33+
"keywords": [
34+
"mcp",
35+
"model-context-protocol",
36+
"ai",
37+
"template",
38+
"llm",
39+
"generator"
40+
],
41+
"author": "mcpdotdirect",
42+
"license": "MIT",
43+
"bugs": {
44+
"url": "https://github.com/mcpdotdirect/template-mcp-server/issues"
1545
},
46+
"homepage": "https://github.com/mcpdotdirect/template-mcp-server#readme",
1647
"devDependencies": {
1748
"@types/bun": "latest",
1849
"@types/cors": "^2.8.17",

0 commit comments

Comments
 (0)