Skip to content

Commit bb3c371

Browse files
committed
Add MacOS troubleshooting guide
- Add troubleshooting guide for MacOS. - Detail prerequisites: uv and npx. - Explain testing CLI directly with uvx. - Provide version check and search command examples. - Explain testing MCP server with inspector. - Show how to run inspector with uvx. - Explain how to invoke tool via inspector. - Include example JSON input for trial_searcher.
1 parent f67c177 commit bb3c371

1 file changed

Lines changed: 55 additions & 0 deletions

File tree

docs/troubleshooting/macos.md

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
# MacOS Troubleshooting Guide
2+
3+
**Prerequisites:**
4+
5+
- Ensure you have `uv` installed. Recommended method for macOS:
6+
```bash
7+
brew install uv
8+
```
9+
For other systems or methods, see the [uv installation guide](https://docs.astral.sh/uv/install/). `uvx` is included with `uv`.
10+
- Ensure you have `npx` available (usually comes with Node.js/npm). Recommended method for macOS if needed:
11+
```bash
12+
brew install node
13+
```
14+
15+
**1. Testing the CLI Directly:**
16+
17+
You can run `biomcp` commands directly without a full installation using `uvx`. This tests if the package is fetchable and the CLI commands execute.
18+
19+
- Check the version:
20+
```bash
21+
uvx --from biomcp-python biomcp version
22+
# Expected Output (version may vary): biomcp version: 0.1.0
23+
```
24+
- Test a search command (e.g., trial search):
25+
```bash
26+
uvx --from biomcp-python biomcp trial search --condition NSCLC --size 1 | head -n 5
27+
# Expected Output (NCT ID and Title will vary):
28+
# # Record 1
29+
# Nct Number: NCT0XXXXXXX
30+
# Study Title:
31+
# Some Title Related to NSCLC
32+
# Study Url: https://clinicaltrials.gov/study/NCT0XXXXXXX
33+
```
34+
35+
**2. Testing the MCP Server with Inspector:**
36+
37+
This verifies that the server starts correctly and the tools are available via the Model Context Protocol.
38+
39+
- Run the inspector, telling it to start your server using the `uvx` command (this mirrors how Smithery likely starts it):
40+
```bash
41+
npx @modelcontextprotocol/inspector uvx --from biomcp-python biomcp run
42+
```
43+
- Open the MCP Inspector interface in your browser (usually `http://127.0.0.1:6274`).
44+
- You should see the list of available tools (e.g., `article_searcher`, `trial_protocol`, `variant_searcher`, etc.).
45+
- Try invoking a tool:
46+
- Select `trial_searcher`.
47+
- Enter valid JSON input matching the `TrialQuery` model, for example:
48+
```json
49+
{
50+
"conditions": ["Melanoma"],
51+
"recruiting_status": "OPEN"
52+
}
53+
```
54+
- Click "Call Tool".
55+
- You should see a Markdown-formatted list of results in the "Output" section.

0 commit comments

Comments
 (0)