Skip to content

Commit 6967b1e

Browse files
committed
updated comments to make clearer for llm what to do
1 parent 0c55108 commit 6967b1e

File tree

6 files changed

+305
-311
lines changed

6 files changed

+305
-311
lines changed

README.md

Lines changed: 9 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ uv sync
5252
### Running the MCP Server
5353

5454
```bash
55-
# Start the MCP server
55+
# Start the MCP server locally
5656
uv run server
5757
```
5858

@@ -91,41 +91,21 @@ A publicly hosted version of this server is also available at `https://biothings
9191

9292
### Integration with AI Systems
9393

94-
Configure your AI system to use the MCP server in one of two ways:
95-
96-
1. Direct SSE Connection:
97-
```json
98-
{
99-
"mcpServers": {
100-
"biothings-mcp": {
101-
"url": "http://localhost:3001/mcp"
102-
}
103-
}
104-
}
105-
```
94+
To integrate this server with your MCP-compatible AI client, you can use one of the preconfigured JSON files provided in this repository:
10695

107-
2. Using mcp-remote (recommended for OAuth support):
108-
```json
109-
{
110-
"mcpServers": {
111-
"biothings-mcp": {
112-
"command": "npx",
113-
"args": [
114-
"mcp-remote",
115-
"http://localhost:3001/mcp",
116-
"6277" // Optional port number for OAuth support
117-
]
118-
}
119-
}
120-
}
121-
```
96+
* **For connecting to a locally running server:** Use `mcp-config.json`. Ensure the server is running first, either via `uv run server` (see [Running the MCP Server](#running-the-mcp-server)) or `docker-compose up` (see [Docker Deployment](#docker-deployment)).
97+
* **For connecting to the publicly hosted server:** Use `mcp-config-remote.json`. This connects to `https://biothings.longevity-genie.info/mcp` and doesn't require you to run anything locally.
12298

123-
You can easily integrate this MCP server with any MCP-compatible client (like Cursor, Windsurv, ClaudeDesktop, etc.). Simply add the server configuration to your client's `mcp-config.json` (or equivalent) file, using either the direct connection or `mcp-remote` method shown above. If running locally using `docker-compose up`, the server address will typically be `http://localhost:3001/mcp`.
99+
Simply point your AI client (like Cursor, Windserve, ClaudeDesktop, VS Code with Copilot, or [others](https://github.com/punkpeye/awesome-mcp-clients)) to use the appropriate configuration file.
124100

125101
Here's an example of how the tools might appear in an MCP client like Cursor after configuration:
126102

127103
![Cursor Usage Example](images/cursor_usage_example.jpg)
128104

105+
## KNOWN ISSUES
106+
107+
The library is alpha-quality. The major problem right now is that LLM-s are often stupid and do not know how to put valid gene and gene variant symbols. We plan to mitigrate it by extending comments and providing additional method for entetity resolution.
108+
129109
## Testing & Verification
130110

131111
Run tests for the API endpoint:

mcp-config-remote.json

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
{
2+
"mcpServers": {
3+
"biothings-mcp": {
4+
"type": "sse",
5+
"url": "https://biothings.longevity-genie.info/mcp"
6+
}
7+
}
8+
}

mcp-config.py renamed to mcp-config.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
{
22
"mcpServers": {
33
"biothings-mcp": {
4+
"type": "sse",
45
"url": "http://localhost:3001/mcp"
56
}
67
}

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[project]
22
name = "biothings-mcp"
3-
version = "0.0.2"
3+
version = "0.0.3"
44
description = "Add your description here"
55
readme = "README.md"
66
authors = [

0 commit comments

Comments
 (0)