Skip to content

Commit 4bf8958

Browse files
authored
Update README.md
1 parent 6c72dc9 commit 4bf8958

1 file changed

Lines changed: 5 additions & 5 deletions

File tree

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ Edit `~/.config/python-agent-harness/config.json` and set your `base_url`, `api_
7676
- **Focused TUI** — a Rich-based interface with a pinned status bar, Todos panel, inline red/green diff rendering for `Edit` and `Write`, and a `prompt_toolkit` editor with history and completion. `Esc+Enter` submits, `Ctrl-D` quits, and `Ctrl-C` cancels without leaving the application.
7777
- **MCP support** — optional MCP integration through the `[mcp]` extra. MCP tools become ordinary agent tools such as `mcp__<server>__<tool>`. Supports `stdio`, `streamable-http`, and `sse` transports.
7878
- **Slash commands** — built-in `/init`, `/review`, `/explain`, and other commands, plus custom commands loaded from `prompts/commands/*.md`.
79-
- **Custom agents** — switch the main agent's system prompt at runtime with `/agent`. Agent prompt files live in `agents/*.md` (like custom commands in `prompts/commands/`). Use `default_agent` in the config file to start sessions with a specific agent.
79+
- **Custom agents** — switch the main agent's system prompt at runtime with `/agent`. Agent prompt files live in `prompts/agents/*.md` (like custom commands in `prompts/commands/`). Use `default_agent` in the config file to start sessions with a specific agent.
8080

8181
## Inspired by opencode
8282

@@ -169,7 +169,7 @@ All LLM settings live in a single JSON configuration file. Environment variables
169169
- **`models`** — named LLM profiles for runtime switching with `/model`. A profile is a partial settings dictionary; unset keys inherit from the main `llm`. `default` restores the main LLM configuration.
170170
- **`context_windows`** — optional per-model context-window overrides (tokens). Keys are model names or substrings (e.g., `deepseek-v4`); matched in file order, first match wins. Overrides the built-in `CONTEXT_WINDOWS` table in `config.py`.
171171
- **`subagent_llm`** — LLM configuration for `Agent` tool requests. Unset values inherit from the main `llm`. Set `profile` to reuse a profile from `models`. Precedence is: profile settings > explicit `subagent_llm` settings > main `llm` > environment variables.
172-
- **`default_agent`** — name of the agent to use at session start (instead of the built-in `agent.md`). The agent must exist as a `.md` file in the `agents/` directory. When unset or `null`, the built-in default agent is used. Use `/agent default` in the TUI to switch back to the built-in at any time.
172+
- **`default_agent`** — name of the agent to use at session start (instead of the built-in `agent.md`). The agent must exist as a `.md` file in the `prompts/agents/` directory. When unset or `null`, the built-in default agent is used. Use `/agent default` in the TUI to switch back to the built-in at any time.
173173
- **`paths.context_path` / `paths.skill_path`** — locations from which to load context files and skills. When unset, the project-local `<project>/contexts` and `<project>/skills` directories are used.
174174
- **`mcp.servers`** — MCP server configuration. Requires the `[mcp]` extra. Each server supports `transport`, `command`, `args`, `env`, `url`, `headers`, `parallel`, `timeout`, and `enabled`.
175175
- **Configuration precedence** — code defaults < config file < `OPENAI_*` environment variables. Sub-agent settings also support `OPENAI_SUBAGENT_*` (`_BASE_URL`, `_API_KEY`, `_MODEL`).
@@ -206,12 +206,12 @@ Custom commands from `prompts/commands/*.md` are registered as slash commands as
206206

207207
### Custom agents
208208

209-
Agent prompt files are markdown files (`.md`) placed in the `agents/` directory. Each file becomes a switchable agent profile available via the `/agent` TUI command. The file's stem (e.g., `reviewer.md``reviewer`) is the agent name; an optional YAML frontmatter block (`name: ...`) can override it. The file body is the agent's system prompt — project context and task-completion rules are still prepended automatically.
209+
Agent prompt files are markdown files (`.md`) placed in the `prompts/agents/` directory. Each file becomes a switchable agent profile available via the `/agent` TUI command. The file's stem (e.g., `reviewer.md``reviewer`) is the agent name; an optional YAML frontmatter block (`name: ...`) can override it. The file body is the agent's system prompt — project context and task-completion rules are still prepended automatically.
210210

211211
```sh
212212
# Create a custom agent
213213
echo 'You are a code reviewer. Focus on bugs, style, and security.' \
214-
> python_agent_harness/agents/reviewer.md
214+
> python_agent_harness/prompts/agents/reviewer.md
215215
```
216216

217217
```
@@ -253,7 +253,7 @@ python_agent_harness/
253253
├── session.py # Session wiring hub + MCP lifecycle
254254
├── subagent.py # Sub-agent runner + error containment
255255
├── commands.py # Init/review/custom command definitions
256-
├── agents/ # Custom agent prompt files (*.md)
256+
├── prompts/agents/ # Custom agent prompt files (*.md)
257257
├── cli.py # CLI entry points
258258
├── tui/ # Rich + prompt_toolkit TUI (package)
259259
├── diffrender.py # Unified diff generation + Rich rendering

0 commit comments

Comments
 (0)