Skip to content

AGENTS.md

Latest commit

 

History

History
386 lines (281 loc) · 18.2 KB

AGENTS.md

File metadata and controls

386 lines (281 loc) · 18.2 KB
Raw

Music Party

A collaborative music playlist intended for LAN parties and parties. Users login with their social credentials (Discord, other OAuth2 providers) and can view the queue, search for tracks, upvote and downvote.

House rules

  • Use subagents for tasks.
  • Use multiple subagents in parallel working as a team, with agent messaging to co-ordinate.
  • A subagent whose result runs long writes it to a file under the session scratchpad and sends only a one-line summary plus that path. Never paste full reports, reviews, or findings into an agent message — they flood the lead's context.
  • Subagents must use an appropriate model, defaults:
    • Explore, Coding, Code Reviews: Sonnet / Terra
    • Codebase Mapping: jcodemunch MCP and Sonnet / Terra
    • Reasoning and Planning: Opus / Sol
    • Trivial, Documentation: Haiku / Luna
  • Explicitly specify the model when starting a subagent.
  • Subagents must use an appropriate subagent type.
  • Do not start a subagent without explicitly setting the model.
  • When building UI to match a mockup, it MUST match the mockup
  • When work is complete, before merging or finishing, run /no-comments or $no-comments

Local Deployment for Development

There is a local deployment for development/user verification using .env.

It is linked with Discord for auth and Spotify for music. It is running in docker with Reverb, Horizon, MariaDB, Redis.

Testing

While editing, run specific unit tests only. CI will be configured to do full testing, linting, static analysis, etc. Any failures in CI will require fixes.

Flaky tests are not allowed. If any tests are considered flaky, then they must be fixed.

Mock APIs and interfaces must be used where possible. Tests should be run in parallel where possible as long as it does not cause CPU load to spike too high.

Run the full suite only when work is completed. If tests fail, fix the issue and re-run just those tests.

Branching and rebasing

Work only on the branch you start on. The integration branch is feature/v3-rewrite and the epic/* branches; main is the stale release branch (origin/main, origin/HEAD, and v1.0.0 all sit on the tagged release, far behind develop).

Never git rebase origin/main (or origin/origin/HEAD) — that replays your work onto the release tip and drags in a mountain of divergence. If you must rebase, rebase onto your task's own base branch (the feature/v3-rewrite or epic/* ref you started from), never the release line.

Never work directly in develop or feature/v3-rewrite. If you would work directly in those, create a worktree and then merge when done.

Cleanup branches and worktrees when they are finished and merged or abandoned.

Code and Technology Guidelines

  • PHP 8
    • FrankenPHP
    • PEST
    • RectorPHP
    • PHPStan (Level 8)
    • xdebug for code coverage
  • MariaDB
  • Laravel
    • Boost MCP
    • Octane
    • Horizon
    • Socialite
    • Inertia
    • Reverb
    • Pint
  • Redis
  • Docker
  • Docker Compose
  • VueJS
    • Vite

Where there is a first-party Laravel package to achieve something, it should be used or there should be an explicit ADR why not.

Code exploration policy

Always use jCodeMunch-MCP for code navigation. Never fall back to Read, Grep, Glob, or Bash for code exploration. Exception: use Read when you are about to edit a file — the harness requires a Read before Edit/Write. Use jCodeMunch to find and understand code, then Read only the file you are changing.

This server runs the front door surface: three tools reach every jCodeMunch capability, so the tool list stays small and the catalogue is fetched only when you need it.

Start any session:

  1. order { "action": "resolve_repo", "args": { "path": "." } } — confirm the project is indexed. If it is not: order { "action": "index_folder", "args": { "path": "." } }

Then, for any task:

  • Know what you want → order { "action": "<name>", "args": { ... } }
  • Know the goal, not the tool → route { "query": "your task in a sentence" } picks the action and shapes the arguments
  • Want to see what exists → menu { "query": "what you are trying to do" } returns matching actions with example arguments
  • Want the whole catalogue and the usage rules → jcodemunch_guide

menu and jcodemunch_guide list every action this server can run, including ones absent from your tool list. That is expected: the front door is the way to call them.

Interpreting results:

  • A verdict of no_implementation_found is evidence of absence. Report the gap; do not re-search with different wording.
  • A verdict of degraded means a channel was unavailable, so absence is NOT proven. Read the note before relying on the result.
  • source: "" alongside source_status means the body could not be read, not that the symbol is empty.

After editing files:

  • With PostToolUse hooks installed (Claude Code), edited files are reindexed automatically.
  • Otherwise order { "action": "register_edit", "args": { "paths": [...] } } after an edit, batched for bulk changes.

Announce your model once per session so the server can size its answers: announce_model { "model": "<your-model-id>" }.

Agent skills

Issue tracker

GitHub Issues via gh; every ticket set hangs off an epic parent with native sub-issues and blocked_by edges. See docs/agents/issue-tracker.md.

Triage labels

Default five triage labels plus epic and work-type labels (coding, research, testing, documentation). See docs/agents/triage-labels.md.

Domain docs

Single-context: GLOSSARY.md and docs/adr/ at the repo root. See docs/agents/domain.md.

===

=== foundation rules ===

Laravel Boost Guidelines

The Laravel Boost guidelines are specifically curated by Laravel maintainers for this application. These guidelines should be followed closely to enhance the user's satisfaction building Laravel applications.

Foundational Context

This application is a Laravel application and its main Laravel ecosystems package & versions are below. You are an expert with them all. Ensure you abide by these specific packages & versions.

  • php - 8.4.26
  • laravel/framework (LARAVEL) - v13
  • laravel/horizon (HORIZON) - v5
  • laravel/octane (OCTANE) - v2
  • laravel/prompts (PROMPTS) - v0
  • laravel/pulse (PULSE) - v1
  • laravel/reverb (REVERB) - v1
  • laravel/sanctum (SANCTUM) - v4
  • laravel/socialite (SOCIALITE) - v5
  • laravel/mcp (MCP) - v1
  • laravel/pint (PINT) - v1
  • pestphp/pest (PEST) - v5
  • phpunit/phpunit (PHPUNIT) - v13
  • laravel-echo (ECHO) - v2
  • vue (VUE) - v3

Conventions

  • You must follow all existing code conventions used in this application. When creating or editing a file, check sibling files for the correct structure, approach, naming.
  • Use descriptive names for variables and methods. For example, isRegisteredForDiscounts, not discount().
  • Check for existing components to reuse before writing a new one.

Verification Scripts

  • Do not create verification scripts or tinker when tests cover that functionality and prove it works. Unit and feature tests are more important.

Application Structure & Architecture

  • Stick to existing directory structure - don't create new base folders without approval.
  • Do not change the application's dependencies without approval.

Frontend Bundling

  • If the user doesn't see a frontend change reflected in the UI, it could mean they need to run npm run build, npm run dev, or composer run dev. Ask them.

Replies

  • Be concise in your explanations - focus on what's important rather than explaining obvious details.

Documentation Files

  • You must only create documentation files if explicitly requested by the user.

=== boost rules ===

Laravel Boost

  • Laravel Boost is an MCP server that comes with powerful tools designed specifically for this application. Use them.

Artisan

  • Use the list-artisan-commands tool when you need to call an Artisan command to double check the available parameters.

URLs

  • Whenever you share a project URL with the user you should use the get-absolute-url tool to ensure you're using the correct scheme, domain / IP, and port.

Tinker / Debugging

  • You should use the tinker tool when you need to execute PHP to debug code or query Eloquent models directly.
  • Use the database-query tool when you only need to read from the database.

Reading Browser Logs With the browser-logs Tool

  • You can read browser logs, errors, and exceptions using the browser-logs tool from Boost.
  • Only recent browser logs will be useful - ignore old logs.

Searching Documentation (Critically Important)

  • Boost comes with a powerful search-docs tool you should use before any other approaches. This tool automatically passes a list of installed packages and their versions to the remote Boost API, so it returns only version-specific documentation specific for the user's circumstance. You should pass an array of packages to filter on if you know you need docs for particular packages.
  • The 'search-docs' tool is perfect for all Laravel related packages, including Laravel, Inertia, Filament, Tailwind, Pest, Nova, Nightwatch, etc.
  • You must use this tool to search for Laravel-ecosystem documentation before falling back to other approaches.
  • Search the documentation before making code changes to ensure we are taking the correct approach.
  • Use multiple, broad, simple, topic based queries to start. For example: ['rate limiting', 'routing rate limiting', 'routing'].
  • Do not add package names to queries - package information is already shared. For example, use test resource table, not filament 4 test resource table.

Available Search Syntax

  • You can and should pass multiple queries at once. The most relevant results will be returned first.
  1. Simple Word Searches with auto-stemming - query=authentication - finds 'authenticate' and 'auth'
  2. Multiple Words (AND Logic) - query=rate limit - finds knowledge containing both "rate" AND "limit"
  3. Quoted Phrases (Exact Position) - query="infinite scroll" - Words must be adjacent and in that order
  4. Mixed Queries - query=middleware "rate limit" - "middleware" AND exact phrase "rate limit"
  5. Multiple Queries - queries=["authentication", "middleware"] - ANY of these terms

=== php rules ===

PHP

  • Always use curly braces for control structures, even if it has one line.

Constructors

  • Use PHP 8 constructor property promotion in __construct().
    • public function __construct(public GitHub $github) { }
  • Do not allow empty __construct() methods with zero parameters.

Type Declarations

  • Always use explicit return type declarations for methods and functions.
  • Use appropriate PHP type hints for method parameters.
protected function isAccessible(User $user, ?string $path = null): bool { ... }

Comments

  • Prefer PHPDoc blocks over comments. Never use comments within the code itself unless there is something very complex going on.

PHPDoc Blocks

  • Add useful array shape type definitions for arrays when appropriate.

Enums

  • Typically, keys in an Enum should be TitleCase. For example: FavoritePerson, BestLake, Monthly.

=== laravel/core rules ===

Do Things the Laravel Way

  • Use php artisan make: commands to create new files (i.e. migrations, controllers, models, etc.). You can list available Artisan commands using the list-artisan-commands tool.
  • If you're creating a generic PHP class, use artisan make:class.
  • Pass --no-interaction to all Artisan commands to ensure they work without user input. You should also pass the correct --options to ensure correct behavior.

Database

  • Always use proper Eloquent relationship methods with return type hints. Prefer relationship methods over raw queries or manual joins.
  • Use Eloquent models and relationships before suggesting raw database queries
  • Avoid DB::; prefer Model::query(). Generate code that leverages Laravel's ORM capabilities rather than bypassing them.
  • Generate code that prevents N+1 query problems by using eager loading.
  • Use Laravel's query builder for very complex database operations.

Model Creation

  • When creating new models, create useful factories and seeders for them too. Ask the user if they need any other things, using list-artisan-commands to check the available options to php artisan make:model.

APIs & Eloquent Resources

  • For APIs, default to using Eloquent API Resources and API versioning unless existing API routes do not, then you should follow existing application convention.

Controllers & Validation

  • Always create Form Request classes for validation rather than inline validation in controllers. Include both validation rules and custom error messages.
  • Check sibling Form Requests to see if the application uses array or string based validation rules.

Queues

  • Use queued jobs for time-consuming operations with the ShouldQueue interface.

Authentication & Authorization

  • Use Laravel's built-in authentication and authorization features (gates, policies, Sanctum, etc.).

URL Generation

  • When generating links to other pages, prefer named routes and the route() function.

Configuration

  • Use environment variables only in configuration files - never use the env() function directly outside of config files. Always use config('app.name'), not env('APP_NAME').

Testing

  • When creating models for tests, use the factories for the models. Check if the factory has custom states that can be used before manually setting up the model.
  • Faker: Use methods such as $this->faker->word() or fake()->randomDigit(). Follow existing conventions whether to use $this->faker or fake().
  • When creating tests, make use of php artisan make:test [options] <name> to create a feature test, and pass --unit to create a unit test. Most tests should be feature tests.

Vite Error

  • If you receive an "Illuminate\Foundation\ViteException: Unable to locate file in Vite manifest" error, you can run npm run build or ask the user to run npm run dev or composer run dev.

=== laravel/v13 rules ===

Laravel 13

  • Use the search-docs tool to get version specific documentation.
  • This project upgraded from Laravel 10 without migrating to the new streamlined Laravel file structure.
  • This is perfectly fine and recommended by Laravel. Follow the existing structure from Laravel 10. We do not to need migrate to the new Laravel structure unless the user explicitly requests that.

Laravel 10 Structure

  • Middleware typically lives in app/Http/Middleware/ and service providers in app/Providers/.
  • There is no bootstrap/app.php application configuration in a Laravel 10 structure:
    • Middleware registration happens in app/Http/Kernel.php
    • Exception handling is in app/Exceptions/Handler.php
    • Console commands and schedule register in app/Console/Kernel.php
    • Rate limits likely exist in RouteServiceProvider or app/Http/Kernel.php

Database

  • When modifying a column, the migration must include all of the attributes that were previously defined on the column. Otherwise, they will be dropped and lost.
  • Laravel 11 allows limiting eagerly loaded records natively, without external packages: $query->latest()->limit(10);.

Models

  • Casts can and likely should be set in a casts() method on a model rather than the $casts property. Follow existing conventions from other models.

=== pint/core rules ===

Laravel Pint Code Formatter

  • You must run vendor/bin/pint --dirty before finalizing changes to ensure your code matches the project's expected style.
  • Do not run vendor/bin/pint --test, simply run vendor/bin/pint to fix any formatting issues.

=== pest/core rules ===

Pest

Testing

  • If you need to verify a feature is working, write or update a Unit / Feature test.

Pest Tests

  • All tests must be written using Pest. Use php artisan make:test --pest <name>.
  • You must not remove any tests or test files from the tests directory without approval. These are not temporary or helper files - these are core to the application.
  • Tests should test all of the happy paths, failure paths, and weird paths.
  • Tests live in the tests/Feature and tests/Unit directories.
  • Pest tests look and behave like this:
it('is true', function () { expect(true)->toBeTrue(); });

Running Tests

  • Run the minimal number of tests using an appropriate filter before finalizing code edits.
  • To run all tests: php artisan test.
  • To run all tests in a file: php artisan test tests/Feature/ExampleTest.php.
  • To filter on a particular test name: php artisan test --filter=testName (recommended after making a change to a related file).
  • When the tests relating to your changes are passing, ask the user if they would like to run the entire test suite to ensure everything is still passing.

Pest Assertions

  • When asserting status codes on a response, use the specific method like assertForbidden and assertNotFound instead of using assertStatus(403) or similar, e.g.:
it('returns all', function () { $response = $this->postJson('/api/docs', []); 
$response->assertSuccessful();

});

Mocking

  • Mocking can be very helpful when appropriate.
  • When mocking, you can use the Pest\Laravel\mock Pest function, but always import it via use function Pest\Laravel\mock; before using it. Alternatively, you can use $this->mock() if existing tests do.
  • You can also create partial mocks using the same import or self method.

Datasets

  • Use datasets in Pest to simplify tests which have a lot of duplicated data. This is often the case when testing validation rules, so consider going with this solution when writing tests for validation rules.
it('has emails', function (string $email) { expect($email)->not->toBeEmpty(); })->with([ 'james' => 'james@laravel.com', 'taylor' => 'taylor@laravel.com', ]);