Skip to content

Commit be9c589

Browse files
authored
docs: add degit usage and MCP Inspector instructions to README (#18)
1 parent 439993b commit be9c589

File tree

2 files changed

+32
-4
lines changed

2 files changed

+32
-4
lines changed

README.md

Lines changed: 31 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,11 +15,13 @@ This template provides:
1515

1616
## Getting Started
1717

18-
1. **Clone or use this template**
18+
The easiest way to get started is using `degit`:
19+
20+
1. **Create a new project from this template**
1921

2022
```bash
21-
git clone <your-repo-url>
22-
cd mcp-typescript-template
23+
npx degit nickytonline/mcp-typescript-template my-mcp-server
24+
cd my-mcp-server
2325
```
2426

2527
2. **Install dependencies**
@@ -41,6 +43,16 @@ This template provides:
4143

4244
The server will be available at `http://localhost:3000` for MCP connections.
4345

46+
### Alternative: Using GitHub Template
47+
48+
You can also click the "Use this template" button on GitHub to create a new repository, then clone it:
49+
50+
```bash
51+
git clone <your-repo-url>
52+
cd my-mcp-server
53+
npm install
54+
```
55+
4456
## Development
4557

4658
### Watch mode for development (with hot reloading)
@@ -83,6 +95,22 @@ npm run format
8395
npm run format:check
8496
```
8597

98+
## Testing Your MCP Server
99+
100+
You can test your MCP server using the [MCP Inspector](https://github.com/modelcontextprotocol/inspector):
101+
102+
```bash
103+
npx @modelcontextprotocol/inspector
104+
```
105+
106+
This will launch a web interface that allows you to:
107+
- Connect to your MCP server
108+
- Test your tools interactively
109+
- View request/response messages
110+
- Debug your MCP implementation
111+
112+
Make sure your server is running (using `npm start` or `npm run dev`) before connecting with the inspector.
113+
86114
## Available Tools
87115

88116
The template includes one example tool:

test-results.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
{"numTotalTestSuites":2,"numPassedTestSuites":2,"numFailedTestSuites":0,"numPendingTestSuites":0,"numTotalTests":4,"numPassedTests":4,"numFailedTests":0,"numPendingTests":0,"numTodoTests":0,"snapshot":{"added":0,"failure":false,"filesAdded":0,"filesRemoved":0,"filesRemovedList":[],"filesUnmatched":0,"filesUpdated":0,"matched":0,"total":0,"unchecked":0,"uncheckedKeysByFile":[],"unmatched":0,"updated":0,"didUpdate":false},"startTime":1753977365976,"success":true,"testResults":[{"assertionResults":[{"ancestorTitles":["createTextResult"],"fullName":"createTextResult should create a CallToolResult with correct structure","status":"passed","title":"should create a CallToolResult with correct structure","duration":0.927375000000012,"failureMessages":[],"meta":{}},{"ancestorTitles":["createTextResult"],"fullName":"createTextResult should handle mock data correctly","status":"passed","title":"should handle mock data correctly","duration":0.15808400000000233,"failureMessages":[],"meta":{}},{"ancestorTitles":["createTextResult"],"fullName":"createTextResult should handle null data","status":"passed","title":"should handle null data","duration":0.05737499999997908,"failureMessages":[],"meta":{}},{"ancestorTitles":["createTextResult"],"fullName":"createTextResult should handle undefined data gracefully by converting to null","status":"passed","title":"should handle undefined data gracefully by converting to null","duration":0.07670899999999392,"failureMessages":[],"meta":{}}],"startTime":1753977366165,"endTime":1753977366166.1582,"status":"passed","message":"","name":"/Users/nicktaylor/dev/oss/mcp-typescript-template/src/lib/utils.test.ts"}]}
1+
{"numTotalTestSuites":2,"numPassedTestSuites":2,"numFailedTestSuites":0,"numPendingTestSuites":0,"numTotalTests":4,"numPassedTests":4,"numFailedTests":0,"numPendingTests":0,"numTodoTests":0,"snapshot":{"added":0,"failure":false,"filesAdded":0,"filesRemoved":0,"filesRemovedList":[],"filesUnmatched":0,"filesUpdated":0,"matched":0,"total":0,"unchecked":0,"uncheckedKeysByFile":[],"unmatched":0,"updated":0,"didUpdate":false},"startTime":1760581355543,"success":true,"testResults":[{"assertionResults":[{"ancestorTitles":["createTextResult"],"fullName":"createTextResult should create a CallToolResult with correct structure","status":"passed","title":"should create a CallToolResult with correct structure","duration":2.7596029999999985,"failureMessages":[],"meta":{}},{"ancestorTitles":["createTextResult"],"fullName":"createTextResult should handle mock data correctly","status":"passed","title":"should handle mock data correctly","duration":0.29587399999999775,"failureMessages":[],"meta":{}},{"ancestorTitles":["createTextResult"],"fullName":"createTextResult should handle null data","status":"passed","title":"should handle null data","duration":0.23338599999999587,"failureMessages":[],"meta":{}},{"ancestorTitles":["createTextResult"],"fullName":"createTextResult should handle undefined data gracefully by converting to null","status":"passed","title":"should handle undefined data gracefully by converting to null","duration":0.20286899999999264,"failureMessages":[],"meta":{}}],"startTime":1760581355808,"endTime":1760581355811.296,"status":"passed","message":"","name":"/home/runner/work/mcp-typescript-template/mcp-typescript-template/src/lib/utils.test.ts"}]}

0 commit comments

Comments
 (0)