Skip to content

Commit 30ccc66

Browse files
committed
Add MCP Inspector Info
Add MCP Inspector info
1 parent a11a017 commit 30ccc66

File tree

2 files changed

+28
-2
lines changed

2 files changed

+28
-2
lines changed

README.md

Lines changed: 28 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ The server is not intended to be a complete or hardened production solution. Ins
3737
- For Windows: CONNX ODBC Driver.
3838
- For Linux: unixODBC with CONNX driver
3939
- Valid CONNX DSN (Data Source Name) configured in your system
40-
- Database credentials with appropriate read/write permissions
40+
- Database and CONNX credentials with appropriate read/write permissions
4141

4242
## Installation
4343

@@ -75,7 +75,7 @@ connection_string = (
7575

7676
## Usage
7777

78-
This server is designed to be launched by an MCP host (e.g., Claude Desktop) using stdio transport.
78+
This server is designed to be launched by an MCP host (e.g., Claude Desktop) using stdio transport. See [Integrate in MCP Host Config](#integrate-in-mcp-host-config)
7979

8080
You typically do not run the Python code manually except for smoke testing.
8181

@@ -329,16 +329,19 @@ Resources (not tools, but available via MCP resources)
329329
## Tool Summary by Use Case
330330

331331
**For exploring data:**
332+
332333
- `describe_entities` - Start here to see what's available
333334
- `query_connx` - Flexible SQL queries
334335

335336
**For customer operations:**
337+
336338
- `get_customer` - Single customer lookup
337339
- `find_customers` - Search by location
338340
- `customers_by_product` - Product-based customer search
339341
- `count_customers` - Quick count
340342

341343
**For analytics:**
344+
342345
- `customers_by_state` - Geographic distribution
343346
- `customers_missing_phone` - Data quality checks
344347
- `count_entities` - Entity counts with natural language
@@ -358,6 +361,29 @@ This project uses pytest for unit testing. Tests mock database interactions to r
358361

359362
Coverage includes connection handling, query/update execution, sanitization, and MCP tools/resources.
360363

364+
# Optional: Install the MCP inspector
365+
366+
The MCP Inspector is a tool for testing and debugging MCP servers.
367+
368+
```bash
369+
# Install npx inspector
370+
npx @modelcontextprotocol/inspector
371+
372+
# Run it against your server
373+
npx @modelcontextprotocol/inspector python /path/to/your/connx_server.py
374+
375+
Example: npx @modelcontextprotocol/inspector python C:\\PythonProjects\\CONNX_MCP_Sample\\connx_server.py
376+
```
377+
378+
This opens a web UI where you can:
379+
380+
- See all available tools
381+
- Test tools with different parameters
382+
- View responses
383+
- Debug issues
384+
385+
![img.png](images/mcp_inspector.png)
386+
361387
---
362388

363389
## Troubleshooting

images/mcp_inspector.png

639 KB
Loading

0 commit comments

Comments
 (0)