Skip to content

Commit aa2fbeb

Browse files
authored
Merge pull request #671 from upstash/update-readme
2 parents 29628d6 + 057bac1 commit aa2fbeb

File tree

1 file changed

+20
-11
lines changed

1 file changed

+20
-11
lines changed

README.md

Lines changed: 20 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ Context7 fetches up-to-date code examples and documentation right into your LLM'
3636
- 2️⃣ Tell the LLM to `use context7`
3737
- 3️⃣ Get working code answers
3838

39-
No tab-switching, no hallucinated APIs that don't exist, no outdated code generations.
39+
No tab-switching, no hallucinated APIs that don't exist, no outdated code generation.
4040

4141
## 📚 Adding Projects
4242

@@ -386,7 +386,7 @@ Open Claude Desktop developer settings and edit your `claude_desktop_config.json
386386
<details>
387387
<summary><b>Install in Opencode</b></summary>
388388

389-
Add this to your Opencode configuration file. See [Opencode MCP docs](https://opencode.ai/docs/mcp-servers) docs for more info.
389+
Add this to your Opencode configuration file. See [Opencode MCP docs](https://opencode.ai/docs/mcp-servers) for more info.
390390

391391
#### Opencode Remote Server Connection
392392

@@ -438,7 +438,7 @@ command = "npx"
438438

439439
See [JetBrains AI Assistant Documentation](https://www.jetbrains.com/help/ai-assistant/configure-an-mcp-server.html) for more details.
440440

441-
1. In JetBrains IDEs go to `Settings` -> `Tools` -> `AI Assistant` -> `Model Context Protocol (MCP)`
441+
1. In JetBrains IDEs, go to `Settings` -> `Tools` -> `AI Assistant` -> `Model Context Protocol (MCP)`
442442
2. Click `+ Add`.
443443
3. Click on `Command` in the top-left corner of the dialog and select the As JSON option from the list
444444
4. Add this configuration and click `OK`
@@ -621,7 +621,7 @@ If you prefer to run the MCP server in a Docker container:
621621
<details>
622622
<summary><b>Install Using the Desktop Extension</b></summary>
623623

624-
Install the [context7.dxt](dxt/context7.dxt) file under the dxt folder and add it to your client. For more information please check out [the desktop extensions docs](https://github.com/anthropics/dxt#desktop-extensions-dxt).
624+
Install the [context7.dxt](dxt/context7.dxt) file under the dxt folder and add it to your client. For more information, please check out [the desktop extensions docs](https://github.com/anthropics/dxt#desktop-extensions-dxt).
625625

626626
</details>
627627

@@ -981,22 +981,31 @@ Context7 MCP provides the following tools that LLMs can use:
981981

982982
### Add a Rule
983983

984-
> If you don’t want to add `use context7` to every prompt, you can define a simple rule in your `.windsurfrules` file in Windsurf or from `Cursor Settings > Rules` section in Cursor (or the equivalent in your MCP client) to auto-invoke Context7 on any code question:
984+
> If you don’t want to add `use context7` to every prompt, you can define a simple rule in your MCP client's rule section:
985985
>
986+
> * For Windsurf, in `.windsurfrules` file
987+
>
988+
> * For Cursor, from `Cursor Settings > Rules` section
989+
>
990+
> * For Claude Code, in `CLAUDE.md` file
991+
>
992+
> Or the equivalent in your MCP client to auto-invoke Context7 on any code question.
993+
>
994+
> Example Rule:
986995
> ```toml
987-
> [[calls]]
988-
> match = "when the user requests code examples, setup or configuration steps, or library/API documentation"
989-
> tool = "context7"
996+
> Always use context7 when I need code generation, setup or configuration steps, or
997+
> library/API documentation. This means you should automatically use the Context7 MCP
998+
> tools to resolve library id and get library docs without me having to explicitly ask.
990999
> ```
9911000
>
992-
> From then on you’ll get Context7’s docs in any related conversation without typing anything extra. You can add your use cases to the match part.
1001+
> From then on, you’ll get Context7’s docs in any related conversation without typing anything extra. You can alter the rule to match your use cases.
9931002
9941003
### Use Library Id
9951004
9961005
> If you already know exactly which library you want to use, add its Context7 ID to your prompt. That way, Context7 MCP server can skip the library-matching step and directly continue with retrieving docs.
9971006
>
9981007
> ```txt
999-
> implement basic authentication with supabase. use library /supabase/supabase for api and docs
1008+
> Implement basic authentication with Supabase. use library /supabase/supabase for API and docs.
10001009
> ```
10011010
>
10021011
> The slash syntax tells the MCP tool exactly which library to load docs for.
@@ -1033,7 +1042,7 @@ bun run dist/index.js
10331042
- `--port <number>` – Port to listen on when using `http` transport (default `3000`).
10341043
- `--api-key <key>` – API key for authentication. You can get your API key by creating an account at [context7.com/dashboard](https://context7.com/dashboard).
10351044

1036-
Example with http transport and port 8080:
1045+
Example with HTTP transport and port 8080:
10371046

10381047
```bash
10391048
bun run dist/index.js --transport http --port 8080

0 commit comments

Comments
 (0)