Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions AGENTS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
This file provides guidance to AI coding agents when working with code in this repository.

## What this project is

`chatwerk` provides an MCP (Model Context Protocol) server built on top of [query_packwerk](https://github.com/rubyatscale/query_packwerk). It lets AI coding assistants (Cursor, Claude, etc.) query packwerk package information, dependencies, and violations from a Ruby codebase.

## Commands

```bash
bundle install

# Run all tests (RSpec)
bundle exec rspec

# Run a single spec file
bundle exec rspec spec/path/to/spec.rb

# Lint
bundle exec rubocop
bundle exec rubocop -a # auto-correct
```

## Architecture

- `lib/chatwerk.rb` — entry point; starts the MCP server
- `lib/chatwerk/` — MCP tool definitions that wrap `query_packwerk` queries (e.g. list packs, show violations, show dependencies)
- `spec/` — RSpec tests
1 change: 1 addition & 0 deletions CLAUDE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
@AGENTS.md