Skip to content

Commit 4fe869c

Browse files
committed
docs: add configuration example to README.md. Included detailed instructions for creating mcp_config.toml with reference sources and prebuilt index path to enhance user understanding of project setup.
1 parent 5eaff57 commit 4fe869c

File tree

1 file changed

+30
-0
lines changed

1 file changed

+30
-0
lines changed

README.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -107,6 +107,36 @@ See [RooCode's documentation](https://github.com/RooVetGit/Roo-Code) for details
107107
- Use your MCP-compatible Agent/IDE to interact with mc-mcp
108108
- Design, search docs, and run TDD cycles (`forge_test`, `search_docs`, etc.)
109109

110+
### Configuration Example
111+
112+
Create a file named `mcp_config.toml` in your project root:
113+
114+
```toml
115+
[reference]
116+
prebuilt_index_path = "artifacts/prebuilt_index.jsonl.gz"
117+
118+
[[reference.sources]]
119+
name = "mc-docs"
120+
source_type = "local"
121+
path = "metacontract/mc/site/docs"
122+
123+
[[reference.sources]]
124+
name = "solidity-docs"
125+
source_type = "local"
126+
path = "docs/solidity"
127+
128+
[[reference.sources]]
129+
name = "user-docs"
130+
source_type = "local"
131+
path = "docs/user"
132+
```
133+
134+
- `prebuilt_index_path` ... (optional) Path to a prebuilt index (jsonl or gzipped jsonl). If set, it will be loaded and upserted into Qdrant on startup.
135+
- Each `[[reference.sources]]` must have `name`, `source_type` (usually `local`), and `path` (relative to the execution directory).
136+
- All paths must exist and be directories, or indexing will fail.
137+
138+
See also: [config.rs](src/config.rs) for the full config structure.
139+
110140
---
111141

112142
## Project Structure

0 commit comments

Comments
 (0)