Getting Started
Getting Started
Home > Documentation > Getting Started
1. Build
git clone https://github.com/n-takatsu/mcp-rs.git
cd mcp-rs
cargo build --release
The executable is target/release/mcp-rs (mcp-rs.exe on Windows). The default build includes the WordPress, database (PostgreSQL), and plugin support.
mcp-rs --version prints the version, and mcp-rs --help lists the options. The only other option is --config <path>.
2. Write a configuration file
Create mcp-config.toml:
[transport]
type = "stdio" # "http" for HTTP mode
[server]
log_level = "warn"
[handlers.wordpress]
enabled = true
url = "https://your-wordpress-site.com"
username = "your_username"
password = "${WORDPRESS_PASSWORD}" # read from the environment
Add only what you use:
[handlers.wordpress]: see WordPress[database]: see Database and the PostgreSQL Integration Guide[[plugins]]: see Plugins[transport.http]for HTTP mode,[audit]for the audit log: see Security
${VAR} is replaced by the environment variable VAR when mcp-rs starts. If a variable used by [handlers.wordpress] is not set, mcp-rs does not start, and the error names the setting.
3. Connect a client
Claude Desktop
Add mcp-rs to claude_desktop_config.json with absolute paths, and pass the environment variables in env:
{
"mcpServers": {
"mcp-rs": {
"command": "/path/to/mcp-rs",
"args": ["--config", "/path/to/mcp-config.toml"],
"env": { "WORDPRESS_PASSWORD": "your application password" }
}
}
}
Claude Desktop does not always pass your own environment variables to mcp-rs, so put them in env.
Claude Code
claude mcp add mcp-rs --scope user \
-e WORDPRESS_PASSWORD="your application password" \
-- /path/to/mcp-rs --config /path/to/mcp-config.toml
VS Code (GitHub Copilot)
The Copilot chat in VS Code uses the MCP servers registered with the Copilot CLI (~/.copilot/mcp-config.json). Keep the credentials in the OS credential store: servers in .vscode/mcp.json that ask for a value with ${input:...} are not passed to the Copilot chat.
copilot mcp add mcp-rs -- /path/to/mcp-rs --config /path/to/mcp-config.toml
Which environment variables reach mcp-rs depends on how the Copilot CLI is started: in VS Code on Windows, almost all of VS Code’s environment except the GitHub token; GitHub Docs says only PATH. With keyring, no environment variables are needed. Variables given with --env always reach mcp-rs, but are written in plain text to ~/.copilot/mcp-config.json. Do not register mcp-rs with credentials in a workspace .mcp.json or .github/mcp.json, which can be committed. If the chat cannot find the tools, the reason is in ~/.copilot/logs/process-*.log (MCP server connection failed).
HTTP clients
Set type = "http" under [transport] and the address under [transport.http]. Turn on authentication before the listener is reachable from other machines: see Security.
4. Check
Before starting a client, mcp-rs check --config /path/to/mcp-config.toml checks the config file the same way mcp-rs reads it: whether it loads, the WordPress credentials, the connection and sign-in to the site (read-only requests), and where the logs are written. It exits with 1 when it finds an error, and does not show passwords. Add --offline to skip the connection to the site.
After the client has started mcp-rs, ask it to call mcp_rs_status. It shows the version, the config file in use, where the log and the audit log are written, and anything that failed to start, with the reason. See the API Reference.
Guides
- PostgreSQL Integration Guide - Connect a database with a read-only role