diff --git a/docs/config-claude-desktop.md b/docs/config-claude-desktop.md new file mode 100644 index 0000000..46106bc --- /dev/null +++ b/docs/config-claude-desktop.md @@ -0,0 +1,24 @@ +# Configuration File + +**Claude Desktop** from Anthropic can talk to MCPShell running in http mode on localhost. + +## Prerequisites + +None. + +## Basic Structure + +The configuration file for **Claude Desktop** is typically located in ~/.config/Claude as **claude_desktop_config.json**. Below are the basic elements required in the file: + +``` +{ + "mcpServers": { + "mcpshell-http": { + "command": "npx", + "args": ["-y", "mcp-remote", "http://localhost:3333/sse"] + } + } +} + +``` + diff --git a/docs/config-codex-cli.md b/docs/config-codex-cli.md new file mode 100644 index 0000000..f93e2b5 --- /dev/null +++ b/docs/config-codex-cli.md @@ -0,0 +1,28 @@ +# Configuration File + +The **Codex CLI** from OpenAI can talk to MCPShell running in http mode on localhost. By design, **Codex CLI** wants to speak MCP over stdio (which is a mode fully supported by MCPShell). However, if you want to use MCPShell in a centralized manner (as a server), you will need to install mcp-proxy. + +## Prerequisites + +A working install of **mcp-proxy**. On many systems this can be installed using **npm**. + +## Basic Structure + +The configuration file for codex is typically located in ~/.codex as **config.toml**. Below are the basic elements required in the file: + +``` +# (Optional) general preferences +network_access = true +model_reasoning_effort = "medium" + +# MCP servers +[mcp_servers.sse_local] +# Use the proxy as a stdio server that connects to your SSE endpoint +command = "mcp-proxy" +args = ["--transport", "streamablehttp", "http://localhost:3333/sse"] +# If you installed via uv and the command isn't on PATH, use the full path, e.g.: +# command = "/home//.local/bin/mcp-proxy" +# You can also pass headers if your SSE server needs auth: +# env = { API_ACCESS_TOKEN = "your-token" } +``` + diff --git a/docs/usage.md b/docs/usage.md index bfcde75..398033f 100644 --- a/docs/usage.md +++ b/docs/usage.md @@ -163,6 +163,8 @@ MCPShell can be integrated with various IDEs and tools: - [Agent Usage Guide](usage-agent.md): Detailed guide for using MCPShell's agent functionality - [VSCode Integration](usage-vscode.md): Guide for integrating MCPShell with Visual Studio Code - [Cursor Integration](usage-cursor.md): Guide for integrating MCPShell with Cursor editor +- [Codex CLI Integration](usage-codex-cli.md): Guide for integrating MCPShell with the Codex CLI +- [Claud Desktop Integration](usage-claude-desktop.md): Guide for integrating MCPShell with Claude Desktop ## Configuration @@ -173,4 +175,4 @@ For information about configuring MCPShell, including defining tools, parameters ## Troubleshooting -For help with common issues, see the [Troubleshooting Guide](troubleshooting.md). \ No newline at end of file +For help with common issues, see the [Troubleshooting Guide](troubleshooting.md).