agentleFS
Google CloudKnown publisherGoogleCloudPlatform/devrel-demos/codelabs/bwg002-devrel-2/AGENTS.md

devrel-demos / bwg002-devrel-2

AGENTS.md397 starsChanged 9 days agoApache-2.0View on GitHub

  • Reads credentials

The file

We split this AGENTS.md into the rules it gives an agent

11 rules. About 0 are common, 3 are distinctive, and 8 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈3

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 8

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Very specific:

    All production application code, specialist agents, workflow orchestrators, evaluation harnesses, and skills MUST live strictly in the …

    line 6
  2. Very specific:

    NEVER create module subfolders (such as module_1/, module_2/, module_3/, module_4/) in the project root.

    line 10
  3. Very specific:

    When introducing or testing lab steps, always verify against the real-world files in pitch_generator/.

    line 14
  4. Very specific:

    Always run git status before finishing a task to ensure no untracked module_<N>/ directories or temporary scratch files were inadvertently …

    line 18
  5. Distinctive:

    When responding with "how to" type suggestions, provide example prompts the user can type that will accomplish the task.

    line 21
  6. Very specific:

    In-Place Surgical Remediation: When the learner asks to remediate or fix a broken step, read the corresponding .agents/solutions/ reference …

    line 33
  7. Very specific:

    Do NOT run bash scripts/deploy.sh, agents-cli deploy, or gcloud run deploy automatically after making code changes.

    line 36
  8. Very specific:

    Post-Deploy URL Sync: After deploying services with scripts/deploy.sh, update VISUAL_DIRECTOR_URL and PITCH_GENERATOR_URL in .env to match …

    line 39
  9. Very specific:

    BigQuery Telemetry Table Safeguards: When initializing or executing live telemetry recording with BigQueryAnalyticsService, ensure the …

    line 40
  10. Distinctive:

    Pitch Generator: - ONLY provide frontend URL

    line 43
  11. Distinctive:

    Visual Director: - ONLY provide A2A agent card URL

    line 44

≈ “Common” is an estimate: at least 1 in 5 of the 40,246 AGENTS.md files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
AGENTS.md

Pitch Generator Project Agent Rules

Codebase Architecture & File Placement

  1. Production Code Locations Only:
    • All production application code, specialist agents, workflow orchestrators, evaluation harnesses, and skills MUST live strictly in the canonical application directory: pitch_generator/ (e.g. pitch_generator/agent.py, pitch_generator/skills/brand-guidelines/SKILL.md, pitch_generator/app_utils/services.py).
    • Top-level entrypoints: call_agent.py and pitch_generator/__init__.py.
  2. No Root Module Folders:
    • NEVER create module subfolders (such as module_1/, module_2/, module_3/, module_4/) in the project root.
    • Reference/gold-standard lab solutions belong strictly in .agents/solutions/module_<N>/ and must never be duplicated into the project root.
  3. Tooling & Verification Alignment:
    • When introducing or testing lab steps, always verify against the real-world files in pitch_generator/.
    • The workspace verification script (.agents/skills/lab-helper/scripts/verify_workspace.py) maintains an app_file_map mapping codelab step artifacts to pitch_generator/. Every step must be mapped to its production counterpart so verification runs against pitch_generator/.
  4. Clean Workspace Integrity:
    • Always run git status before finishing a task to ensure no untracked module_<N>/ directories or temporary scratch files were inadvertently created in the project root.
  5. Provide prompts, not Python command lines:
    • When responding with "how to" type suggestions, provide example prompts the user can type that will accomplish the task. NEVER provide Python commandline instructions for the user to type.
  6. Canonical CLI Testing, Setup, Local Server & Cloud Run Deployment Scripts:
    • CLI Agent Testing: Whenever asked to test or run the Pitch Generator agent with a prompt (e.g., "Test the agent with 'Flying skateboards for cats'"), ALWAYS execute python3 call_agent.py "<prompt>" (do NOT pass --offline unless explicitly asked).
    • Cloud Run Deployment: Whenever asked to deploy the application, agents, or frontend to Cloud Run, ALWAYS execute bash scripts/deploy.sh (do NOT run raw gcloud run deploy commands directly). scripts/deploy.sh automatically loads .env, detects whether remote_visual_director has been implemented in pitch_generator/agent.py, deploys visual-director first when present, and wires VISUAL_DIRECTOR_URL into pitch-generator.
    • Cloud Infrastructure Setup: Whenever asked to set up or provision Google Cloud prerequisites (Cloud Storage bucket, BigQuery dataset, Cloud Resource connection, or IAM bindings), ALWAYS execute bash scripts/setup.sh.
    • Local Server Lifecycle: Whenever asked to start, restart, check, or stop the local web server or frontend, ALWAYS use bash .agents/skills/start-frontend/scripts/start_server.sh (see .agents/skills/start-frontend/SKILL.md).
  7. Follow In-File Guideposts, Never Peek at .agents/solutions/, and Keep Verification On-Demand:
    • Follow In-File Guidepost Comments First (Single-Call Reading): Before designing or writing code for any user request, locate the corresponding # [Guidepost — Step <id> comment block in pitch_generator/agent.py, pitch_generator/app_utils/services.py, or pitch_generator/fast_api_app.py. NEVER read files in small 50–80 line increments across multiple turns: all specialist agents, workflow edges, and lab guideposts in pitch_generator/agent.py live in lines 1–370, and pitch_generator/app_utils/services.py is under 450 lines total, so view them in a single view_file call (or use grep_search with Query="# [Guidepost — Step" to jump directly to the exact line). Always use the exact agent names, output_key bindings, function signatures, and integration symbols mentioned in that guidepost comment, and leave future guidepost comments for later steps intact.
    • Never Read .agents/solutions/ During Implementation: Do NOT view, search, or read any files under .agents/solutions/ when implementing features or answering coding requests. .agents/solutions/ may ONLY be accessed when the learner explicitly asks for a hint, asks to verify a step, or asks to fix/remediate their workspace via the lab-helper skill.
    • Strictly On-Demand Verification: To conserve time and turns during the lab, do NOT run verify_workspace.py or unsolicited test suites after implementing a step unless the learner explicitly asks to verify, test, or troubleshoot their work.
    • In-Place Surgical Remediation: When the learner asks to remediate or fix a broken step, read the corresponding .agents/solutions/ reference file and patch pitch_generator/ in-place rather than overwriting the entire cumulative file, so earlier work, user customizations, and upcoming guidepost comments are preserved.
  8. Never Deploy Unless Explicitly Asked by the Learner:
    • Do NOT run bash scripts/deploy.sh, agents-cli deploy, or gcloud run deploy automatically after making code changes. Cloud Run deployment takes several minutes, so wait until the learner explicitly asks you to deploy in their prompt.
  9. Environment URL Synchronization & BigQuery Telemetry Invariants:
    • Post-Deploy URL Sync: After deploying services with scripts/deploy.sh, update VISUAL_DIRECTOR_URL and PITCH_GENERATOR_URL in .env to match the deployed Cloud Run HTTPS URLs so CLI agent invocations route to live services with proper OIDC authentication.
    • BigQuery Telemetry Table Safeguards: When initializing or executing live telemetry recording with BigQueryAnalyticsService, ensure the destination dataset (bwg) and table (agent_events) exist with required schema fields before streaming rows via insert_rows_json.
  10. Giving URLs to the learner:
  • Pitch Generator - ONLY provide frontend URL
  • Visual Director - ONLY provide A2A agent card URL

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.