obsidian-plugin/rait-09_obsidian-agent-client
1
0
Fork 0
mirror of https://github.com/rait-09/obsidian-agent-client.git synced 2026-07-22 06:43:37 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
rait-09_obsidian-agent-client/docs/agent-setup/custom-agents.md
RAIT-09 8bbe40a2a3 Add VitePress documentation site for Agent Client 
Introduces a full documentation site under docs/ using VitePress, including configuration, custom theme, setup guides for supported agents (Claude Code, Codex, Gemini CLI, custom agents), usage instructions, FAQ, troubleshooting, and images. Updates .gitignore and .prettierignore to exclude VitePress build output and docs. Also updates package.json and eslint config for documentation support.
2025-12-14 01:53:46 +09:00

1.6 KiB
Raw Blame History

Custom Agents Setup

You can use any agent that implements the Agent Client Protocol (ACP).

Install and Configure

  1. Install your ACP-compatible agent (e.g., OpenCode, Qwen Code).

  2. Find the installation path:

::: code-group

which your-agent
# Example output: /usr/local/bin/your-agent

where.exe your-agent
# Example output: C:\Users\Username\AppData\Roaming\npm\your-agent.cmd

:::

  1. Open Settings → Agent Client and scroll to Custom Agents section.

  2. Click Add custom agent.

  3. Configure the agent:

    • Agent ID: Unique identifier (e.g., my-agent)
    • Display name: Name shown in menus (e.g., My Agent)
    • Path: Absolute path to the agent executable
    • Arguments: Command-line arguments, one per line (if required)
    • Environment variables: KEY=VALUE pairs, one per line (if required)

Authentication

Authentication depends on the specific agent. Common patterns:

  • API Key: Add to Environment variables (e.g., MY_API_KEY=xxx)
  • Account Login: Run the agent's CLI to authenticate, then leave environment variables empty

Refer to your agent's documentation for specific authentication instructions.

Verify Setup

  1. Click the robot icon in the ribbon or use the command palette: "Open agent chat"
  2. Select your custom agent from the agent dropdown in the chat header
  3. Try sending a message to verify the connection

Having issues? See Troubleshooting.