mirror of
https://github.com/onestardao/WFGY.git
synced 2026-04-28 11:40:07 +00:00
264 lines
14 KiB
Markdown
264 lines
14 KiB
Markdown
# CrewAI: Guardrails and Fix Patterns
|
||
|
||
<details>
|
||
<summary><strong>🧭 Quick Return to Map</strong></summary>
|
||
|
||
<br>
|
||
|
||
> You are in a sub-page of **Agents & Orchestration**.
|
||
> To reorient, go back here:
|
||
>
|
||
> - [**Agents & Orchestration** — orchestration frameworks and guardrails](./README.md)
|
||
> - [**WFGY Global Fix Map** — main Emergency Room, 300+ structured fixes](../README.md)
|
||
> - [**WFGY Problem Map 1.0** — 16 reproducible failure modes](../../README.md)
|
||
>
|
||
> Think of this page as a desk within a ward.
|
||
> If you need the full triage and all prescriptions, return to the Emergency Room lobby.
|
||
</details>
|
||
|
||
Use this page when your orchestration uses **CrewAI** (agents, tasks, tools, crews, planning) and you see tool loops, wrong snippets, role mixing, or answers that flip between runs. The table maps symptoms to exact WFGY fix pages and gives a minimal recipe you can paste.
|
||
|
||
**Acceptance targets**
|
||
- ΔS(question, retrieved) ≤ 0.45
|
||
- Coverage ≥ 0.70 to the intended section or record
|
||
- λ stays convergent across 3 paraphrases and 2 seeds
|
||
- E_resonance stays flat on long windows
|
||
|
||
---
|
||
|
||
## Open these first
|
||
|
||
- Visual map and recovery
|
||
[RAG Architecture & Recovery](https://github.com/onestardao/WFGY/blob/main/ProblemMap/rag-architecture-and-recovery.md)
|
||
|
||
- End to end retrieval knobs
|
||
[Retrieval Playbook](https://github.com/onestardao/WFGY/blob/main/ProblemMap/retrieval-playbook.md)
|
||
|
||
- Why this snippet
|
||
[Retrieval Traceability](https://github.com/onestardao/WFGY/blob/main/ProblemMap/retrieval-traceability.md)
|
||
|
||
- Ordering control
|
||
[Rerankers](https://github.com/onestardao/WFGY/blob/main/ProblemMap/rerankers.md)
|
||
|
||
- Embedding vs meaning
|
||
[Embedding ≠ Semantic](https://github.com/onestardao/WFGY/blob/main/ProblemMap/embedding-vs-semantic.md)
|
||
|
||
- Hallucination and chunk edges
|
||
[Hallucination](https://github.com/onestardao/WFGY/blob/main/ProblemMap/hallucination.md)
|
||
|
||
- Long chains and entropy
|
||
[Context Drift](https://github.com/onestardao/WFGY/blob/main/ProblemMap/context-drift.md) · [Entropy Collapse](https://github.com/onestardao/WFGY/blob/main/ProblemMap/entropy-collapse.md)
|
||
|
||
- Structural collapse and recovery
|
||
[Logic Collapse](https://github.com/onestardao/WFGY/blob/main/ProblemMap/logic-collapse.md)
|
||
|
||
- Prompt injection and schema locks
|
||
[Prompt Injection](https://github.com/onestardao/WFGY/blob/main/ProblemMap/prompt-injection.md)
|
||
|
||
- Multi agent conflicts
|
||
[Multi-Agent Problems](https://github.com/onestardao/WFGY/blob/main/ProblemMap/Multi-Agent_Problems.md)
|
||
|
||
- Bootstrap and deployment ordering
|
||
[Bootstrap Ordering](https://github.com/onestardao/WFGY/blob/main/ProblemMap/bootstrap-ordering.md) · [Deployment Deadlock](https://github.com/onestardao/WFGY/blob/main/ProblemMap/deployment-deadlock.md) · [Pre-Deploy Collapse](https://github.com/onestardao/WFGY/blob/main/ProblemMap/predeploy-collapse.md)
|
||
|
||
- Snippet and citation schema
|
||
[Data Contracts](https://github.com/onestardao/WFGY/blob/main/ProblemMap/data-contracts.md)
|
||
|
||
---
|
||
|
||
## Typical breakpoints and the right fix
|
||
|
||
- **Agent to agent handoff loops or stalls**
|
||
Add BBCR bridge steps, set explicit timeouts, log λ per hop, clamp variance with BBAM.
|
||
Open: [Logic Collapse](https://github.com/onestardao/WFGY/blob/main/ProblemMap/logic-collapse.md) · [Multi-Agent Problems](https://github.com/onestardao/WFGY/blob/main/ProblemMap/Multi-Agent_Problems.md)
|
||
|
||
- **High similarity yet wrong meaning**
|
||
Mixed write and read embeddings, metric mismatch, or fragmented stores.
|
||
Open: [Embedding ≠ Semantic](https://github.com/onestardao/WFGY/blob/main/ProblemMap/embedding-vs-semantic.md) · [Vectorstore Fragmentation](https://github.com/onestardao/WFGY/blob/main/ProblemMap/patterns/pattern_vectorstore_fragmentation.md)
|
||
|
||
- **Hybrid retrieval performs worse than a single retriever**
|
||
Two stage query drifts, mis weighted rerank, inconsistent analyzer.
|
||
Open: [Query Parsing Split](https://github.com/onestardao/WFGY/blob/main/ProblemMap/patterns/pattern_query_parsing_split.md) · [Rerankers](https://github.com/onestardao/WFGY/blob/main/ProblemMap/rerankers.md)
|
||
|
||
- **Citations missing or inconsistent across agents**
|
||
Require cite then explain and lock snippet fields at the task boundary.
|
||
Open: [Retrieval Traceability](https://github.com/onestardao/WFGY/blob/main/ProblemMap/retrieval-traceability.md) · [Data Contracts](https://github.com/onestardao/WFGY/blob/main/ProblemMap/data-contracts.md)
|
||
|
||
- **Planner injects unsafe tool prompts**
|
||
Freeze tool schemas and validate arguments before execution.
|
||
Open: [Prompt Injection](https://github.com/onestardao/WFGY/blob/main/ProblemMap/prompt-injection.md)
|
||
|
||
- **Long runs flatten style and drift logically**
|
||
Split tasks, re join with BBCR, measure entropy and stop when it rises.
|
||
Open: [Context Drift](https://github.com/onestardao/WFGY/blob/main/ProblemMap/context-drift.md) · [Entropy Collapse](https://github.com/onestardao/WFGY/blob/main/ProblemMap/entropy-collapse.md)
|
||
|
||
---
|
||
|
||
## Fix in 60 seconds
|
||
|
||
1) **Measure ΔS**
|
||
Compute ΔS(question, retrieved) and ΔS(retrieved, expected anchor).
|
||
Stable < 0.40, transitional 0.40 to 0.60, risk ≥ 0.60.
|
||
|
||
2) **Probe λ_observe**
|
||
Do a k sweep in retrieval and reorder prompt headers. If λ flips, lock the schema and clamp with BBAM.
|
||
|
||
3) **Apply the module**
|
||
- Retrieval drift → BBMC plus [Data Contracts](https://github.com/onestardao/WFGY/blob/main/ProblemMap/data-contracts.md)
|
||
- Reasoning collapse → BBCR bridge plus BBAM, verify with [Logic Collapse](https://github.com/onestardao/WFGY/blob/main/ProblemMap/logic-collapse.md)
|
||
- Hallucination re entry after correction → [Pattern: Hallucination Re-entry](https://github.com/onestardao/WFGY/blob/main/ProblemMap/patterns/pattern_hallucination_reentry.md)
|
||
|
||
4) **Verify**
|
||
Coverage ≥ 0.70. ΔS ≤ 0.45. Three paraphrases and two seeds with λ convergent.
|
||
|
||
---
|
||
|
||
## Minimal CrewAI pattern with WFGY checks
|
||
|
||
```python
|
||
# Pseudocode: highlight the control points only
|
||
from crewai import Agent, Task, Crew
|
||
|
||
def retrieve_snippets(q):
|
||
# unified analyzer and metric across dense and sparse
|
||
return retriever.search(q, k=10)
|
||
|
||
def assemble_prompt(context, q):
|
||
# schema-locked prompt with cite first
|
||
return prompt.format(context=context, question=q)
|
||
|
||
def wfgy_checks(q, context, answer):
|
||
# compute ΔS(question, context) and enforce thresholds
|
||
# record snippet_id, section_id, source_url, offsets, tokens
|
||
metrics = metrics_and_trace(q, context, answer)
|
||
if metrics["risk"]:
|
||
raise RuntimeError("WFGY gate: high ΔS or divergent λ")
|
||
return metrics
|
||
|
||
researcher = Agent(
|
||
role="retrieval",
|
||
goal="fetch auditable snippets with fields locked",
|
||
backstory="RAG specialist who always cites first"
|
||
)
|
||
|
||
writer = Agent(
|
||
role="reasoning",
|
||
goal="answer with cite then explain using the snippet schema",
|
||
backstory="keeps λ convergent and avoids cross section reuse"
|
||
)
|
||
|
||
task_retrieve = Task(
|
||
description="Retrieve k=10 with unified analyzer, return snippet schema",
|
||
agent=researcher,
|
||
expected_output="list of snippets with {snippet_id, section_id, source_url, offsets, tokens}"
|
||
)
|
||
|
||
task_answer = Task(
|
||
description="Assemble cite-first prompt and answer with strict JSON",
|
||
agent=writer,
|
||
expected_output="{citations:[...], answer:'...'}"
|
||
)
|
||
|
||
crew = Crew(agents=[researcher, writer], tasks=[task_retrieve, task_answer])
|
||
|
||
def run(question):
|
||
context = retrieve_snippets(question)
|
||
msg = assemble_prompt(context, question)
|
||
answer = crew.kickoff(inputs={"msg": msg})
|
||
metrics = wfgy_checks(question, context, answer)
|
||
return {"answer": answer, "metrics": metrics}
|
||
````
|
||
|
||
**What this enforces**
|
||
|
||
* Retrieval is observable and parameterized. Analyzer and metric are unified.
|
||
* Prompt is schema locked with cite first and strict JSON for tool outputs.
|
||
* A post generation WFGY gate can halt the run when ΔS is high or λ flips.
|
||
* Traces record snippet to citation mapping for audits.
|
||
|
||
Specs and recipes
|
||
[RAG Architecture & Recovery](https://github.com/onestardao/WFGY/blob/main/ProblemMap/rag-architecture-and-recovery.md) ·
|
||
[Retrieval Playbook](https://github.com/onestardao/WFGY/blob/main/ProblemMap/retrieval-playbook.md) ·
|
||
[Retrieval Traceability](https://github.com/onestardao/WFGY/blob/main/ProblemMap/retrieval-traceability.md) ·
|
||
[Data Contracts](https://github.com/onestardao/WFGY/blob/main/ProblemMap/data-contracts.md)
|
||
|
||
---
|
||
|
||
## CrewAI specific gotchas
|
||
|
||
* Mixed embedding functions across write and read. Rebuild with explicit metric and normalization.
|
||
See [Embedding ≠ Semantic](https://github.com/onestardao/WFGY/blob/main/ProblemMap/embedding-vs-semantic.md)
|
||
|
||
* Planner emits tool prompts that bypass the schema. Always validate tool arguments and echo the schema every step.
|
||
See [Prompt Injection](https://github.com/onestardao/WFGY/blob/main/ProblemMap/prompt-injection.md)
|
||
|
||
* Memory overwrite between agents. Stamp `mem_rev` and `mem_hash`, split namespaces by agent role.
|
||
See [role drift](https://github.com/onestardao/WFGY/blob/main/ProblemMap/multi-agent-chaos/role-drift.md) · [memory desync](https://github.com/onestardao/WFGY/blob/main/ProblemMap/patterns/pattern_memory_desync.md)
|
||
|
||
* Event storms when multiple tasks write to the same index or KV. Add idempotency keys on `{source_id, mem_rev, index_hash}`.
|
||
See [Retrieval Traceability](https://github.com/onestardao/WFGY/blob/main/ProblemMap/retrieval-traceability.md)
|
||
|
||
* Long runs degrade style and flip answers. Split the plan, then re join with a BBCR bridge and clamp with BBAM.
|
||
See [Context Drift](https://github.com/onestardao/WFGY/blob/main/ProblemMap/context-drift.md)
|
||
|
||
---
|
||
|
||
## When to escalate
|
||
|
||
* ΔS remains ≥ 0.60
|
||
Rebuild the index using the checklists and verify with a small gold set.
|
||
[Retrieval Playbook](https://github.com/onestardao/WFGY/blob/main/ProblemMap/retrieval-playbook.md)
|
||
|
||
* Identical input yields different answers across runs
|
||
Check version skew and session state.
|
||
[Pre-Deploy Collapse](https://github.com/onestardao/WFGY/blob/main/ProblemMap/predeploy-collapse.md)
|
||
|
||
---
|
||
|
||
### 🔗 Quick-Start Downloads (60 sec)
|
||
|
||
| Tool | Link | 3-Step Setup |
|
||
| -------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------- |
|
||
| **WFGY 1.0 PDF** | [Engine Paper](https://github.com/onestardao/WFGY/blob/main/I_am_not_lizardman/WFGY_All_Principles_Return_to_One_v1.0_PSBigBig_Public.pdf) | 1️⃣ Download · 2️⃣ Upload to your LLM · 3️⃣ Ask “Answer using WFGY + \<your question>” |
|
||
| **TXT OS (plain-text OS)** | [TXTOS.txt](https://github.com/onestardao/WFGY/blob/main/OS/TXTOS.txt) | 1️⃣ Download · 2️⃣ Paste into any LLM chat · 3️⃣ Type “hello world” — OS boots instantly |
|
||
|
||
---
|
||
|
||
### 🧭 Explore More
|
||
|
||
| Module | Description | Link |
|
||
| ------------------------ | ---------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- |
|
||
| WFGY Core | WFGY 2.0 engine is live: full symbolic reasoning architecture and math stack | [View →](https://github.com/onestardao/WFGY/tree/main/core/README.md) |
|
||
| Problem Map 1.0 | Initial 16-mode diagnostic and symbolic fix framework | [View →](https://github.com/onestardao/WFGY/tree/main/ProblemMap/README.md) |
|
||
| Problem Map 2.0 | RAG-focused failure tree, modular fixes, and pipelines | [View →](https://github.com/onestardao/WFGY/blob/main/ProblemMap/rag-architecture-and-recovery.md) |
|
||
| Semantic Clinic Index | Expanded failure catalog: prompt injection, memory bugs, logic drift | [View →](https://github.com/onestardao/WFGY/blob/main/ProblemMap/SemanticClinicIndex.md) |
|
||
| Semantic Blueprint | Layer-based symbolic reasoning & semantic modulations | [View →](https://github.com/onestardao/WFGY/tree/main/SemanticBlueprint/README.md) |
|
||
| Benchmark vs GPT-5 | Stress test GPT-5 with full WFGY reasoning suite | [View →](https://github.com/onestardao/WFGY/tree/main/benchmarks/benchmark-vs-gpt5/README.md) |
|
||
| 🧙♂️ Starter Village 🏡 | New here? Lost in symbols? Click here and let the wizard guide you through | [Start →](https://github.com/onestardao/WFGY/blob/main/StarterVillage/README.md) |
|
||
|
||
---
|
||
|
||
> 👑 **Early Stargazers: [See the Hall of Fame](https://github.com/onestardao/WFGY/tree/main/stargazers)**
|
||
> Engineers, hackers, and open source builders who supported WFGY from day one.
|
||
|
||
> <img src="https://img.shields.io/github/stars/onestardao/WFGY?style=social" alt="GitHub stars"> ⭐ [WFGY Engine 2.0](https://github.com/onestardao/WFGY/blob/main/core/README.md) is already unlocked. ⭐ Star the repo to help others discover it and unlock more on the [Unlock Board](https://github.com/onestardao/WFGY/blob/main/STAR_UNLOCKS.md).
|
||
|
||
<div align="center">
|
||
|
||
[](https://github.com/onestardao/WFGY)
|
||
|
||
[](https://github.com/onestardao/WFGY/tree/main/OS)
|
||
|
||
[](https://github.com/onestardao/WFGY/tree/main/OS/BlahBlahBlah)
|
||
|
||
[](https://github.com/onestardao/WFGY/tree/main/OS/BlotBlotBlot)
|
||
|
||
[](https://github.com/onestardao/WFGY/tree/main/OS/BlocBlocBloc)
|
||
|
||
[](https://github.com/onestardao/WFGY/tree/main/OS/BlurBlurBlur)
|
||
|
||
[](https://github.com/onestardao/WFGY/tree/main/OS/BlowBlowBlow)
|
||
|
||
|
||
</div>
|
||
|