Skip to content

Commit

Permalink
Update MCP Readme with autostart option (eclipse-theia#15046)
Browse files Browse the repository at this point in the history
* Update MCP Readme with autostart option

fixed eclipse-theia#15045
  • Loading branch information
JonasHelming authored Feb 25, 2025
1 parent 3dde0ac commit 82a3e31
Showing 1 changed file with 24 additions and 2 deletions.
26 changes: 24 additions & 2 deletions packages/ai-mcp/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,10 @@ The AI MCP package provides an integration that allows users to start and use MC

## Configuration

Make sure to configure your MCP servers properly within the preference settings.
To configure MCP servers, open the preferences and add entries to the `MCP Servers Configuration` section. Each server requires a unique identifier (e.g., `"brave-search"` or `"filesystem"`) and configuration details such as the command, arguments, optional environment variables, and autostart (true by default).

`"autostart"` (true by default) will automatically start the respective MCP server whenever you restart your Theia application. In your current session, however, you'll still need to **manually start it** using the `"MCP: Start MCP Server"` command.


Example Configuration:

Expand All @@ -53,7 +56,8 @@ Example Configuration:
"args": [
"-y",
"@modelcontextprotocol/server-memory"
]
],
"autostart": false
},
"brave-search": {
"command": "npx",
Expand All @@ -73,6 +77,23 @@ Example Configuration:
"ABSOLUTE_PATH_TO_ALLOWED_DIRECTORY",
]
},
"git": {
"command": "uv",
"args": [
"--directory",
"/path/to/repo",
"run",
"mcp-server-git"
]
},
"git2": {
"command": "uvx",
"args": [
"mcp-server-git",
"--repository",
"/path/to/otherrepo"
]
}
}
}
```
Expand All @@ -88,4 +109,5 @@ Search the internet for XYZ
```

## More Information
[User documentation on MCP in the Theia IDE](https://theia-ide.org/docs/user_ai/#mcp-integration)
[List of available MCP servers](https://github.com/modelcontextprotocol/servers)

0 comments on commit 82a3e31

Please sign in to comment.