summaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorDax Raad <[email protected]>2025-06-14 14:52:02 -0400
committerDax Raad <[email protected]>2025-06-14 14:52:02 -0400
commit37bb8895fefdf87af4ddbb4b754a690548ba8ff5 (patch)
treefb19265ed8a39c6f4d5a612e93536607ac597bb9
parent89b95be4de64babe7050ccc2ed51adaaf208b15f (diff)
downloadopencode-37bb8895fefdf87af4ddbb4b754a690548ba8ff5.tar.gz
opencode-37bb8895fefdf87af4ddbb4b754a690548ba8ff5.zip
docs: readme
-rw-r--r--README.md46
1 files changed, 22 insertions, 24 deletions
diff --git a/README.md b/README.md
index 2f19371e1..5924c906b 100644
--- a/README.md
+++ b/README.md
@@ -55,7 +55,28 @@ Project configuration is optional. You can place an `opencode.json` file in the
}
```
-### Providers
+#### MCP
+
+```json title="opencode.json"
+{
+ "$schema": "http://opencode.ai/config.json",
+ "mcp": {
+ "localmcp": {
+ "type": "local",
+ "command": ["bun", "x", "my-mcp-command"],
+ "environment": {
+ "MY_ENV_VAR": "my_env_var_value"
+ }
+ },
+ "remotemcp": {
+ "type": "remote",
+ "url": "https://my-mcp-server.com"
+ }
+ }
+}
+```
+
+#### Providers
You can use opencode with any provider listed at [here](https://ai-sdk.dev/providers/ai-sdk-providers). Use the npm package name as the key in your config. Note we use v5 of the ai-sdk and not all providers support that yet.
@@ -79,29 +100,6 @@ You can use opencode with any provider listed at [here](https://ai-sdk.dev/provi
}
```
-#### Provider Options
-
-#### MCP
-
-```json title="opencode.json"
-{
- "$schema": "http://opencode.ai/config.json",
- "mcp": {
- "localmcp": {
- "type": "local",
- "command": ["bun", "x", "my-mcp-command"],
- "environment": {
- "MY_ENV_VAR": "my_env_var_value"
- }
- },
- "remotemcp": {
- "type": "remote",
- "url": "https://my-mcp-server.com"
- }
- }
-}
-```
-
### Contributing
To run opencode locally you need