You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+12-5
Original file line number
Diff line number
Diff line change
@@ -90,6 +90,13 @@ If you prefer to build from source, you will need the
90
90
91
91
## Usage
92
92
93
+
**Important Note for New Crates:**
94
+
95
+
When using the server with a crate for the first time (or with a new version/feature set), it needs to download the documentation and generate embeddings. This process can take some time, especially for crates with extensive documentation, and requires an active internet connection and OpenAI API key.
96
+
97
+
It is recommended to run the server once directly from your command line for any new crate configuration *before* adding it to your AI coding assistant (like Roo Code, Cursor, etc.). This allows the initial embedding generation and caching to complete. Once you see the server startup messages indicating it's ready (e.g., "MCP Server listening on stdio"), you can shut it down (Ctrl+C). Subsequent launches, including those initiated by your coding assistant, will use the cached data and start much faster.
98
+
99
+
93
100
### Running the Server
94
101
95
102
The server is launched from the command line and requires the **Package ID
@@ -109,19 +116,19 @@ necessary for crates that require specific features to be enabled for
109
116
export OPENAI_API_KEY="sk-..."
110
117
111
118
# Example: Run server for the latest 1.x version of serde
112
-
./target/release/rustdocs_mcp_server "serde@^1.0"
119
+
rustdocs_mcp_server "serde@^1.0"
113
120
114
121
# Example: Run server for a specific version of reqwest
0 commit comments