Skip to content

Commit 6972a7a

Browse files
committed
Add instruction on testing
1 parent 4e72ebf commit 6972a7a

File tree

1 file changed

+39
-0
lines changed

1 file changed

+39
-0
lines changed

README.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,9 @@ A Python utility package for building Model Context Protocol (MCP) servers.
2626
- [Contributing](#contributing)
2727
- [Related Projects](#related-projects)
2828
- [License](#license)
29+
- [Testing with MCP Inspector](#testing-with-mcp-inspector)
30+
- [Installation](#installation-1)
31+
- [Usage](#usage-1)
2932

3033
## Overview
3134

@@ -226,3 +229,39 @@ Contributions are welcome! Please feel free to submit a Pull Request.
226229
## License
227230

228231
MIT License
232+
233+
## Testing with MCP Inspector
234+
235+
The [MCP Inspector](https://github.com/modelcontextprotocol/inspector) is a useful tool for testing and debugging MCP servers. It provides a web interface to inspect and test MCP server endpoints.
236+
237+
### Installation
238+
239+
Install MCP Inspector using npm:
240+
241+
```bash
242+
npm install -g @modelcontextprotocol/inspector
243+
```
244+
245+
### Usage
246+
247+
1. Start your MCP server (e.g., the Flask example above)
248+
2. Run MCP Inspector:
249+
250+
```bash
251+
git clone [email protected]:modelcontextprotocol/inspector.git
252+
cd inspector
253+
npm run build
254+
npm start
255+
```
256+
257+
3. Open your browser and navigate to `http://127.0.0.1:6274/`
258+
4. Enter your MCP server URL (e.g., `http://localhost:9000/sse`)
259+
5. Use the inspector to:
260+
- Change transport type to SSE
261+
- Test server connections
262+
- Monitor SSE events
263+
- Send test messages
264+
- Debug responses
265+
266+
This tool is particularly useful during development to ensure your MCP server implementation
267+
is working correctly and complies with the protocol specification.

0 commit comments

Comments
 (0)