Connects AI models to an Obsidian vault so they can read, search and edit notes.
Setup
Choose your client, copy the config, then fill in any required environment variables.
claude mcp add obsidian-newtype-01 --env VAULT_PATH='<VAULT_PATH>' --env API_TOKEN='<API_TOKEN>' --env OBSIDIAN_API_PORT='<OBSIDIAN_API_PORT>' --env OBSIDIAN_API_TOKEN='<OBSIDIAN_API_TOKEN>' --env OBSIDIAN_VAULT_PATH='<OBSIDIAN_VAULT_PATH>' -- npx @huangyihe/obsidian-mcp~/.codex/config.toml
[mcp_servers.obsidian-newtype-01]
command = "npx"
args = ["@huangyihe/obsidian-mcp"]
env = { VAULT_PATH = "<VAULT_PATH>", API_TOKEN = "<API_TOKEN>", OBSIDIAN_API_PORT = "<OBSIDIAN_API_PORT>", OBSIDIAN_API_TOKEN = "<OBSIDIAN_API_TOKEN>", OBSIDIAN_VAULT_PATH = "<OBSIDIAN_VAULT_PATH>" }
# codex mcp add obsidian-newtype-01 --env VAULT_PATH='<VAULT_PATH>' --env API_TOKEN='<API_TOKEN>' --env OBSIDIAN_API_PORT='<OBSIDIAN_API_PORT>' --env OBSIDIAN_API_TOKEN='<OBSIDIAN_API_TOKEN>' --env OBSIDIAN_VAULT_PATH='<OBSIDIAN_VAULT_PATH>' -- npx @huangyihe/obsidian-mcp~/.cursor/mcp.json
{
"mcpServers": {
"obsidian-newtype-01": {
"command": "npx",
"args": [
"@huangyihe/obsidian-mcp"
],
"env": {
"VAULT_PATH": "<VAULT_PATH>",
"API_TOKEN": "<API_TOKEN>",
"OBSIDIAN_API_PORT": "<OBSIDIAN_API_PORT>",
"OBSIDIAN_API_TOKEN": "<OBSIDIAN_API_TOKEN>",
"OBSIDIAN_VAULT_PATH": "<OBSIDIAN_VAULT_PATH>"
}
}
}
}.vscode/mcp.json
{
"servers": {
"obsidian-newtype-01": {
"type": "stdio",
"command": "npx",
"args": [
"@huangyihe/obsidian-mcp"
],
"env": {
"VAULT_PATH": "<VAULT_PATH>",
"API_TOKEN": "<API_TOKEN>",
"OBSIDIAN_API_PORT": "<OBSIDIAN_API_PORT>",
"OBSIDIAN_API_TOKEN": "<OBSIDIAN_API_TOKEN>",
"OBSIDIAN_VAULT_PATH": "<OBSIDIAN_VAULT_PATH>"
}
}
}
}~/.gemini/settings.json
{
"mcpServers": {
"obsidian-newtype-01": {
"command": "npx",
"args": [
"@huangyihe/obsidian-mcp"
],
"env": {
"VAULT_PATH": "<VAULT_PATH>",
"API_TOKEN": "<API_TOKEN>",
"OBSIDIAN_API_PORT": "<OBSIDIAN_API_PORT>",
"OBSIDIAN_API_TOKEN": "<OBSIDIAN_API_TOKEN>",
"OBSIDIAN_VAULT_PATH": "<OBSIDIAN_VAULT_PATH>"
}
}
}
}claude_desktop_config.json
{
"mcpServers": {
"obsidian-newtype-01": {
"command": "npx",
"args": [
"@huangyihe/obsidian-mcp"
],
"env": {
"VAULT_PATH": "<VAULT_PATH>",
"API_TOKEN": "<API_TOKEN>",
"OBSIDIAN_API_PORT": "<OBSIDIAN_API_PORT>",
"OBSIDIAN_API_TOKEN": "<OBSIDIAN_API_TOKEN>",
"OBSIDIAN_VAULT_PATH": "<OBSIDIAN_VAULT_PATH>"
}
}
}
}.trae/mcp.json
{
"mcpServers": {
"obsidian-newtype-01": {
"command": "npx",
"args": [
"@huangyihe/obsidian-mcp"
],
"env": {
"VAULT_PATH": "<VAULT_PATH>",
"API_TOKEN": "<API_TOKEN>",
"OBSIDIAN_API_PORT": "<OBSIDIAN_API_PORT>",
"OBSIDIAN_API_TOKEN": "<OBSIDIAN_API_TOKEN>",
"OBSIDIAN_VAULT_PATH": "<OBSIDIAN_VAULT_PATH>"
}
}
}
}Environment variables
VAULT_PATHAPI_TOKENOBSIDIAN_API_PORTOBSIDIAN_API_TOKENOBSIDIAN_VAULT_PATH
Replace the placeholders with your own credentials and keep them out of version control.