AI agent guide
AI agent setup and interaction guide
AiyoPerps can actively wake an AI agent under scheduled or threshold-based conditions, and it can also accept agent-led operation. This guide uses OpenAI Codex as the reference setup path.
1Install OpenAI Codex CLI
- Skip this step if Codex CLI is already installed.
- Codex App can also operate AiyoPerps through MCP, but it cannot currently be conditionally woken by AiyoPerps, so Codex CLI is the recommended path.
- OpenAI currently recommends installing Codex CLI inside WSL for Windows users. Follow the official instructions on the OpenAI Codex CLI page.
- Run Codex CLI once to confirm it starts correctly.
2Install AiyoPerps MCP
- Installing AiyoPerps MCP reduces the time and token cost needed for AI agent interaction.
- AiyoPerps MCP only allows local connections, including WSL virtual network interfaces on Windows.
- Use the same installation command on Linux and Windows.
npx -y @phidiassj/aiyoperps-mcp-installer
3Configure AI agent behavior in AiyoPerps
- Click Agent Settings from the upper-left side of the Dashboard to open the AI agent settings window.
- Enable AI Agent so the settings on this screen take effect.
- Wake interval controls timed agent wake-up in minutes. Set it to
0to disable scheduled wake-up. - Prompt template is where you define the strategy, analytical task, or execution instructions. You can include MCP tool names and parameter references from the MCP and REST API handbook.
- Conditional wake-up lets you wake the agent based on price or unrealized PnL percentage thresholds.
Next step
Open the MCP and REST API handbook
After AI agent setup, the most useful follow-up is the full reference page for MCP tool names and parameter fields.
Open MCP and REST API handbookBack to the guides hub
If you want a single shareable entry point for your team, use the guides hub as the documentation landing page.
Return to the guides hub