Skip to content

AGENTS.md

Latest commit

 

History

History
80 lines (58 loc) · 2.87 KB

AGENTS.md

File metadata and controls

80 lines (58 loc) · 2.87 KB
Raw

All paths in the protocol should be absolute

Adding new methods

  • Create empty params and output structs in src/client.rs or src/agent.rs under the corresponding section. I'll add the fields myself.

  • If the protocol method name is noun/verb, use verb_noun for the user facing methods and structs.

    Example 1 (noun/noun): Protocol method: terminal/output Trait method name: terminal_output Request/Response structs: TerminalOutputRequest / TerminalOutputResponse Method names struct: terminal_output: &'static str

    Example 2 (noun/verb): Protocol method: terminal/new Trait method name: new_terminal Request/Response structs: NewTerminalRequest / NewTerminalResponse Method names struct: terminal_new: &'static str

  • Add constants for the method names

  • Add variants to {Agent|Client}{Request|Response} enums

  • Add the method to src/bin/generate.rs SideDocs functions

  • Run npm run generate and fix any issues that appear

  • Run npm run check

  • Update the example agents and clients in tests and examples in both libraries

Schema rules

  • For any nullable field, explicitly define whether it is required or optional and whether null is equivalent to an omitted key before running schema generation.

Updating existing methods, their params, or output

  • Update the mintlify docs and guides in the docs directory
  • Run npm run check to make sure the json and zod schemas gets generated properly

Never write readme files related to the conversation unless explicitly asked to.

Conventional Commits

This repository uses Conventional Commits for automated releases via release-plz. All commit messages should follow this format:

<type>[optional scope]: <description>

[optional body]

[optional footer(s)]

Commit Types

  • feat: A new feature (triggers minor version bump)
  • fix: A bug fix (triggers patch version bump)
  • docs: Documentation only changes
  • style: Code style changes (formatting, missing semicolons, etc.)
  • refactor: Code changes that neither fix bugs nor add features
  • perf: Performance improvements
  • test: Adding or updating tests
  • chore: Maintenance tasks, dependency updates, etc.
  • ci: CI/CD configuration changes
  • build: Build system or external dependency changes

Examples

feat(schema): add support for dynamic proxy chains
fix(unstable): resolve deadlock in message routing
docs(rfd): update README with installation instructions
chore: bump tokio to 1.40

Scope Guidelines

Common scopes for this repository:

  • schema - Anything that touches the actual generated schema
  • unstable - Any changes that would only touch unstable features
  • unstable-v2 - Any changes that would only touch v2
  • rust - Any changes that only touch Rust code and how Rust handles the data with no changes to the schema
  • rfd - Any changes that only touch RFD documentation