Skip to content

Commit f3adf65

Browse files
committed
add MCP setup instructions
1 parent 772fe75 commit f3adf65

1 file changed

Lines changed: 34 additions & 1 deletion

File tree

README.md

Lines changed: 34 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ A Model Context Protocol (MCP) server that provides RAG-powered semantic search
1111

1212
## Quick Start
1313

14-
**1. Create `askdocs-mcp.toml` in your docs directory:**
14+
**1. Create `askdocs-mcp.toml` in your project's docs directory:**
1515

1616
```toml
1717
[[doc]]
@@ -53,6 +53,39 @@ description = "Human description"
5353
path = "pdf/document.pdf"
5454
```
5555

56+
## Using the MCP Server:
57+
58+
### Cursor (`~/.cursor/mcp.json` or `<project-root>/.cursor/mcp.json`)
59+
60+
```json
61+
{
62+
"mcpServers": {
63+
"askdocs-mcp": {
64+
"command": "docker",
65+
"args": [
66+
"run", "-i", "--rm",
67+
"--network=host",
68+
"--volume=${workspaceFolder}/docs:/docs",
69+
"ghcr.io/dymk/askdocs-mcp:latest"
70+
]
71+
}
72+
}
73+
}
74+
```
75+
76+
### Codex (`~/.codex/config.toml`)
77+
78+
```toml
79+
[mcp_servers.askdocs-mcp]
80+
command = "docker"
81+
args = [
82+
"run", "-i", "--rm",
83+
"--network=host",
84+
"--volume=/your/workspace/folder/docs:/docs",
85+
"ghcr.io/dymk/askdocs-mcp:latest"
86+
]
87+
```
88+
5689
**Environment variable:**
5790
- `ASKDOCS_OLLAMA_URL`: Ollama server URL (default: `http://localhost:11434`)
5891

0 commit comments

Comments
 (0)