mirror of https://github.com/rennf93/roboco.git synced 2026-08-03 07:23:24 +02:00

Files

T

Renn F f48106cbb6 docs: reflow hard-wrapped prose to one line per paragraph

Markdown and editors soft-wrap on their own, so the manual ~75-char line
breaks across the docs added nothing but noise. Join wrapped prose, list
items, and paragraphs into single lines across 67 docs — README, CLAUDE.md,
deployment, usage, the RAG knowledge base, and the agent role prompts.
Whitespace-only: code fences, tables, and blockquote alerts are byte-identical
and the change is token-verified (no content altered). Applied with a
deterministic reflow tool (committed separately).

Also lands two doc edits that were awaiting commit: the measured under-load
resource numbers in usage.md and the pr_reviewer additions to the
org-structure RAG doc.

2026-06-16 23:18:55 +02:00

3.7 KiB

Raw Blame History

Knowledge Base Tools

Search and Query

Tool	Purpose
`roboco_kb_search`	Semantic search
`roboco_rag_query`	AI-synthesized answer
`roboco_ask_mentor`	Conversational help
`roboco_kb_stats`	Index statistics

Semantic Search

roboco_kb_search(
    query="rate limiting redis",
    top_k=5,
    project="roboco",
    index_types=["code", "docs"]
)

AI-Generated Answers

roboco_rag_query(
    query="How does authentication work?",
    top_k=5
)

Mentor (Conversational)

response = roboco_ask_mentor(
    question="How do I handle auth?",
    domain="coding"
)

# Follow-up
roboco_ask_mentor(
    question="What about refresh tokens?",
    conversation_id=response["conversation_id"]
)

Documentation Writing (Documenter, Cell PM)

# Write/update documentation (auto-dedup via RAG)
roboco_docs_write({
    "task_id": "task-uuid",
    "filename": "api-endpoints.md",
    "doc_type": "api",  # api, qa, guide, readme, changelog, architecture, design
    "title": "API Endpoints",
    "content": "# API Endpoints\n\n..."
})

# List docs for a task
roboco_docs_list(task_id="task-uuid")

# Read a doc
roboco_docs_read(path="backend/api/endpoints.md")

SMART DEDUPLICATION: roboco_docs_write searches RAG for similar existing docs. If high-similarity match found, updates instead of creating duplicate.

Bulk Indexing

# Index code (PM, Developer)
roboco_kb_index_code(
    sources=["src/**/*.py"],
    project="roboco"
)

# Index docs (PM, Documenter) - for bulk/explicit indexing
# Note: roboco_docs_write() auto-indexes when writing
roboco_kb_index_docs(
    sources=["docs/**/*.md"],
    project="roboco"
)

Error Tracking

# Search for similar errors
roboco_search_error(
    error_message="Redis connection timed out",
    context="startup"
)

# Record solution
roboco_record_error_solution(
    error_message="Redis connection timed out",
    solution="Added retry with backoff",
    worked=True
)

Decision Tracking

# Check for similar decisions
roboco_check_decision(topic="session storage")

# Record decision
roboco_record_decision(params={
    topic: "Session storage",
    decision: "Use Redis",
    rationale: "Sub-ms reads"
})

Standards & Validation

Get Standards

roboco_get_standards(domain="coding", language="python")

Domains: coding, security, workflow, architecture

Validate Action (LLM-Based)

Uses LLM to check code/context against organizational standards.

result = roboco_validate_action(
    action_type="create_endpoint",
    context="""
def create_user(email, password):
    user = User(email=email, password=password)
    db.add(user)
    return user
"""
)

Returns:

{
  "allowed": false,
  "violations": [
    {
      "rule_id": "SEC-001",
      "rule_title": "Password Hashing",
      "message": "Password stored in plaintext",
      "severity": "error",
      "suggestion": "Hash password with bcrypt before storage"
    }
  ],
  "warnings": [...],
  "relevant_standards": [...]
}

How it works:

Searches KB for relevant standards based on action_type
Sends standards + context to LLM for analysis
Returns structured violations with fix suggestions
Falls back to heuristic matching if LLM unavailable

Action types: create_endpoint, add_dependency, database_migration, auth_change, file_upload, external_api

Code Review

roboco_review_code(
    code="def handle(...):",
    file_path="src/api/auth.py",
    change_type="modify"  # add, modify, delete
)

Returns: Score (0-100), comments by severity, approval status

3.7 KiB Raw Blame History