Skip to content

Commit 37d16f8

Browse files
dduuggclaude
andauthored
Add AGENTS.md and CLAUDE.md for AI coding agent guidance (#3)
* Add AGENTS.md and CLAUDE.md for AI coding agent guidance * Fix inaccuracies in AGENTS.md - Remove redundant heading that repeats the filename - Fix incorrect spec/fixtures/ references where that directory doesn't exist - Fix Claude-specific intro text to be agent-agnostic (pks only) Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com> --------- Co-authored-by: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>
1 parent c30321a commit 37d16f8

File tree

2 files changed

+28
-0
lines changed

2 files changed

+28
-0
lines changed

AGENTS.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
This file provides guidance to AI coding agents when working with code in this repository.
2+
3+
## What this project is
4+
5+
`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.
6+
7+
## Commands
8+
9+
```bash
10+
bundle install
11+
12+
# Run all tests (RSpec)
13+
bundle exec rspec
14+
15+
# Run a single spec file
16+
bundle exec rspec spec/path/to/spec.rb
17+
18+
# Lint
19+
bundle exec rubocop
20+
bundle exec rubocop -a # auto-correct
21+
```
22+
23+
## Architecture
24+
25+
- `lib/chatwerk.rb` — entry point; starts the MCP server
26+
- `lib/chatwerk/` — MCP tool definitions that wrap `query_packwerk` queries (e.g. list packs, show violations, show dependencies)
27+
- `spec/` — RSpec tests

CLAUDE.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
@AGENTS.md

0 commit comments

Comments
 (0)