cognee/cognee-mcp/README.md
Hande ebebbb8958
chore: update mcp readme (#914)
<!-- .github/pull_request_template.md -->

## Description
<!-- Provide a clear description of the changes in this PR -->

## DCO Affirmation
I affirm that all code in every commit of this pull request conforms to
the terms of the Topoteretes Developer Certificate of Origin.
2025-06-06 12:16:01 +02:00

120 lines
2.5 KiB
Markdown

# cognee MCP server
Please refer to our documentation [here](https://docs.cognee.ai/how-to-guides/deployment/mcp) for further information.
### Installing Manually
A MCP server project
=======
1. Clone the [cognee](https://github.com/topoteretes/cognee) repo
2. Install dependencies
```
brew install uv
```
```jsx
cd cognee-mcp
uv sync --dev --all-extras --reinstall
```
3. Activate the venv with
```jsx
source .venv/bin/activate
```
4. Add the new server to your Claude config:
The file should be located here: ~/Library/Application\ Support/Claude/
```
cd ~/Library/Application\ Support/Claude/
```
You need to create claude_desktop_config.json in this folder if it doesn't exist
Make sure to add your paths and LLM API key to the file bellow
Use your editor of choice, for example Nano:
```
nano claude_desktop_config.json
```
```
{
"mcpServers": {
"cognee": {
"command": "/Users/{user}/cognee/.venv/bin/uv",
"args": [
"--directory",
"/Users/{user}/cognee/cognee-mcp",
"run",
"cognee"
],
"env": {
"ENV": "local",
"TOKENIZERS_PARALLELISM": "false",
"LLM_API_KEY": "sk-"
}
}
}
}
```
Restart your Claude desktop.
### Installing via Smithery
To install Cognee for Claude Desktop automatically via [Smithery](https://smithery.ai/server/cognee):
```bash
npx -y @smithery/cli install cognee --client claude
```
Define cognify tool in server.py
Restart your Claude desktop.
## Running the Server
### Standard stdio transport:
```bash
python src/server.py
```
### SSE transport:
```bash
python src/server.py --transport sse
```
## Development and Debugging
To use debugger, run:
```bash
mcp dev src/server.py
```
Open inspector with timeout passed:
```
http://localhost:5173?timeout=120000
```
To apply new changes while developing cognee you need to do:
1. `poetry lock` in cognee folder
2. `uv sync --dev --all-extras --reinstall`
3. `mcp dev src/server.py`
### Development
In order to use local cognee build, run in root of the cognee repo:
```bash
poetry build -o ./cognee-mcp/sources
```
After the build process is done, change the cognee library dependency inside the `cognee-mcp/pyproject.toml` from
```toml
cognee[postgres,codegraph,gemini,huggingface]==0.1.38
```
to
```toml
cognee[postgres,codegraph,gemini,huggingface]
```
After that add the following snippet to the same file (`cognee-mcp/pyproject.toml`).
```toml
[tool.uv.sources]
cognee = { path = "sources/cognee-0.1.38-py3-none-any.whl" }
```