Skip to content

Commit cf025cc

Browse files
committed
docs: update to illustrate cost
1 parent a51c652 commit cf025cc

File tree

1 file changed

+4
-6
lines changed

1 file changed

+4
-6
lines changed

README.md

+4-6
Original file line numberDiff line numberDiff line change
@@ -83,8 +83,8 @@ export OPENAI_API_KEY="sk-..."
8383
On the first run for a specific crate version *and feature set*, the server will:
8484
1. Download the crate documentation using `cargo doc` (with specified features).
8585
2. Parse the HTML documentation.
86-
3. Generate embeddings for the documentation content using the OpenAI API (this may take some time and incur costs, though typically only fractions of a US penny for most crates, potentially a few pennies for crates with exceptionally large documentation).
87-
4. Cache the documentation content and embeddings.
86+
3. Generate embeddings for the documentation content using the OpenAI API (this may take some time and incur costs, though typically only fractions of a US penny for most crates; even a large crate like `async-stripe` with over 5000 documentation pages cost only $0.18 USD for embedding generation during testing).
87+
4. Cache the documentation content and embeddings so that the cost isn't incurred again.
8888
5. Start the MCP server.
8989
9090
Subsequent runs for the same crate version *and feature set* will load the data from the cache, making startup much faster.
@@ -154,8 +154,7 @@ You can configure MCP clients like Roo Code to run multiple instances of this se
154154
"command": "rustdocs_mcp_server",
155155
"args": [
156156
157-
"-F",
158-
"runtime-tokio-hyper-rustls"
157+
"-F runtime-tokio-hyper-rustls"
159158
],
160159
"env": {
161160
"OPENAI_API_KEY": "YOUR_OPENAI_API_KEY_HERE"
@@ -190,8 +189,7 @@ For Claude Desktop users, you can configure the server in the MCP settings. Here
190189
"command": "rustdocs_mcp_server",
191190
"args": [
192191
193-
"-F",
194-
"runtime-tokio-hyper-rustls"
192+
"-F runtime-tokio-hyper-rustls"
195193
]
196194
}
197195
}

0 commit comments

Comments
 (0)