Skip to content

Commit f5ed4df

Browse files
Add concrete instructions for agents to fetch knowledge base from GitHub
1 parent 5e1a3a1 commit f5ed4df

File tree

1 file changed

+10
-4
lines changed

1 file changed

+10
-4
lines changed

AAE.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -240,15 +240,21 @@ The loop runs until the user manually interrupts.
240240

241241
## Knowledge Base
242242

243-
This methodology is supported by a community-contributed knowledge base of optimization techniques, experiment results, and lessons learned from AAE sessions. Before or during a tuning session, consider consulting the knowledge base for techniques relevant to your problem:
243+
This methodology is supported by a community-contributed knowledge base of optimization techniques, experiment results, and lessons learned from AAE sessions. The knowledge base lives in the AAE repository at:
244244

245-
1. Read `knowledge-base/INDEX.md` to scan titles, problem domains, and key techniques.
246-
2. Read individual entries that seem relevant to the current problem.
245+
https://github.com/CHSZLab/AgenticAlgorithmEngineering/tree/main/knowledge-base
246+
247+
Before or during a tuning session, consult the knowledge base for techniques relevant to your problem:
248+
249+
1. Fetch the index: `curl -sL https://raw.githubusercontent.com/CHSZLab/AgenticAlgorithmEngineering/main/knowledge-base/INDEX.md` and scan titles, problem domains, and key techniques.
250+
2. Fetch individual entries that seem relevant (same base URL, replace `INDEX.md` with the entry filename from the index).
247251
3. Use the insights to inform hypothesis generation in the AE cycle.
248252

253+
If you have web search or web fetch tools available, use those instead of curl. If the knowledge base is available locally (e.g. as a git submodule or in the same repository), read the files directly.
254+
249255
### Contributing Back
250256

251-
If your AAE run produces insights that could help others, ask the user whether you may submit a PR to the knowledge base. If the user agrees, fork the repository (if needed), create a new entry following the template in `knowledge-base/CONTRIBUTING.md`, update `INDEX.md`, and open a pull request via `gh` or the GitHub MCP server.
257+
If your AAE run produces insights that could help others, ask the user whether you may submit a PR to the knowledge base. If the user agrees, fork the AAE repository (if needed), create a new entry following the template in `knowledge-base/CONTRIBUTING.md`, update `INDEX.md`, and open a pull request via `gh` or the GitHub MCP server.
252258

253259
Never create the PR without explicit user permission.
254260

0 commit comments

Comments
 (0)