Skip to content

A self-hostable bookmark-everything app (links, notes and images) with AI-based automatic tagging and full text search

docs: add codex desktop to mcp docs

Mohamed Bassem6ccbe89c11c2
diff --git a/docs/docs/05-integrations/03-mcp.md b/docs/docs/05-integrations/03-mcp.md
index 8ddcf8f9..c996d92c 100644
--- a/docs/docs/05-integrations/03-mcp.md
+++ b/docs/docs/05-integrations/03-mcp.md
@@ -1,6 +1,6 @@
# Model Context Protocol Server (MCP)
-Karakeep comes with a Model Context Protocol server that can be used to interact with it through LLMs.
+Karakeep comes with a Model Context Protocol server that can allow LLMs (like claude and codex) to interact with your karakeep data.
## Supported Tools
@@ -41,7 +41,7 @@ From NPM:
"@karakeep/mcp"
],
"env": {
- "KARAKEEP_API_ADDR": "https://<YOUR_SERVER_ADDR>",
+ "KARAKEEP_API_ADDR": "https://cloud.karakeep.app",
"KARAKEEP_API_KEY": "<YOUR_TOKEN>"
}
}
@@ -59,7 +59,7 @@ From Docker:
"args": [
"run",
"-e",
- "KARAKEEP_API_ADDR=https://<YOUR_SERVER_ADDR>",
+ "KARAKEEP_API_ADDR=https://cloud.karakeep.app",
"-e",
"KARAKEEP_API_KEY=<YOUR_TOKEN>",
"ghcr.io/karakeep-app/karakeep-mcp:latest"
@@ -69,6 +69,13 @@ From Docker:
}
```
+# Usage with Codex Desktop
+
+1. Get an API Key from your Karakeep settings page.
+2. Go to Codex Settings > Integrations > Plugins > Add > Add MCP Server.
+3. Use the following configuration, replacing the placeholder with your API key.
+
+![codex](/img/mcp/codex.png)
### Demo
diff --git a/docs/static/img/mcp/codex.png b/docs/static/img/mcp/codex.png
new file mode 100644
index 00000000..828551f7
Binary files /dev/null and b/docs/static/img/mcp/codex.png differ
diff --git a/docs/versioned_docs/version-v0.33.0/05-integrations/03-mcp.md b/docs/versioned_docs/version-v0.33.0/05-integrations/03-mcp.md
index 8ddcf8f9..c996d92c 100644
--- a/docs/versioned_docs/version-v0.33.0/05-integrations/03-mcp.md
+++ b/docs/versioned_docs/version-v0.33.0/05-integrations/03-mcp.md
@@ -1,6 +1,6 @@
# Model Context Protocol Server (MCP)
-Karakeep comes with a Model Context Protocol server that can be used to interact with it through LLMs.
+Karakeep comes with a Model Context Protocol server that can allow LLMs (like claude and codex) to interact with your karakeep data.
## Supported Tools
@@ -41,7 +41,7 @@ From NPM:
"@karakeep/mcp"
],
"env": {
- "KARAKEEP_API_ADDR": "https://<YOUR_SERVER_ADDR>",
+ "KARAKEEP_API_ADDR": "https://cloud.karakeep.app",
"KARAKEEP_API_KEY": "<YOUR_TOKEN>"
}
}
@@ -59,7 +59,7 @@ From Docker:
"args": [
"run",
"-e",
- "KARAKEEP_API_ADDR=https://<YOUR_SERVER_ADDR>",
+ "KARAKEEP_API_ADDR=https://cloud.karakeep.app",
"-e",
"KARAKEEP_API_KEY=<YOUR_TOKEN>",
"ghcr.io/karakeep-app/karakeep-mcp:latest"
@@ -69,6 +69,13 @@ From Docker:
}
```
+# Usage with Codex Desktop
+
+1. Get an API Key from your Karakeep settings page.
+2. Go to Codex Settings > Integrations > Plugins > Add > Add MCP Server.
+3. Use the following configuration, replacing the placeholder with your API key.
+
+![codex](/img/mcp/codex.png)
### Demo