Working MCP

Author: martinemde

.gitignore

@@ -7,5 +7,7 @@
 /spec/reports/
 /tmp/
 
+/vendor/
+
 # rspec failure tracking
 .rspec_status

Gemfile

@@ -1,13 +1,19 @@
 # frozen_string_literal: true
 
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
 # Specify your gem's dependencies in chatwerk.gemspec
 gemspec
 
-gem "irb"
-gem "rake", "~> 13.0"
+gem 'mcp-rb', path: '/Users/martin.emde/workspace/mcp_investigation/mcp-base'
+gem 'query_packwerk', path: '/Users/martin.emde/workspace/github.com/rubyatscale/query_packwerk'
 
-gem "rspec", "~> 3.0"
+gem 'irb'
+gem 'rake', '~> 13.0'
 
-gem "rubocop", "~> 1.21"
+gem 'rspec', '~> 3.0'
+
+gem 'rubocop', '~> 1.21'
+gem 'rubocop-performance'
+gem 'rubocop-sorbet'
+gem 'sorbet', '~> 0.5'

Gemfile.lock

@@ -0,0 +1,197 @@
+PATH
+  remote: .
+  specs:
+    chatwerk (0.1.0)
+      mcp-rb (~> 0.4)
+      query_packwerk (~> 0.1)
+      sorbet-runtime
+      thor (~> 1.2)
+
+PATH
+  remote: /Users/martin.emde/workspace/github.com/rubyatscale/query_packwerk
+  specs:
+    query_packwerk (0.1.0)
+      coderay
+      packwerk
+      parse_packwerk
+      rubocop
+      sorbet-runtime
+      thor
+
+PATH
+  remote: /Users/martin.emde/workspace/mcp_investigation/mcp-base
+  specs:
+    mcp-rb (0.4.0)
+      addressable (~> 2.8.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionview (8.0.2)
+      activesupport (= 8.0.2)
+      builder (~> 3.1)
+      erubi (~> 1.11)
+      rails-dom-testing (~> 2.2)
+      rails-html-sanitizer (~> 1.6)
+    activesupport (8.0.2)
+      base64
+      benchmark (>= 0.3)
+      bigdecimal
+      concurrent-ruby (~> 1.0, >= 1.3.1)
+      connection_pool (>= 2.2.5)
+      drb
+      i18n (>= 1.6, < 2)
+      logger (>= 1.4.2)
+      minitest (>= 5.1)
+      securerandom (>= 0.3)
+      tzinfo (~> 2.0, >= 2.0.5)
+      uri (>= 0.13.1)
+    addressable (2.8.7)
+      public_suffix (>= 2.0.2, < 7.0)
+    ast (2.4.3)
+    base64 (0.2.0)
+    benchmark (0.4.0)
+    better_html (2.1.1)
+      actionview (>= 6.0)
+      activesupport (>= 6.0)
+      ast (~> 2.0)
+      erubi (~> 1.4)
+      parser (>= 2.4)
+      smart_properties
+    bigdecimal (3.1.9)
+    builder (3.3.0)
+    coderay (1.1.3)
+    concurrent-ruby (1.3.5)
+    connection_pool (2.5.0)
+    constant_resolver (0.2.0)
+    crass (1.0.6)
+    date (3.4.1)
+    diff-lcs (1.6.0)
+    drb (2.2.1)
+    erubi (1.13.1)
+    i18n (1.14.7)
+      concurrent-ruby (~> 1.0)
+    io-console (0.8.0)
+    irb (1.15.1)
+      pp (>= 0.6.0)
+      rdoc (>= 4.0.0)
+      reline (>= 0.4.2)
+    json (2.10.2)
+    language_server-protocol (3.17.0.4)
+    lint_roller (1.1.0)
+    logger (1.6.6)
+    loofah (2.24.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.12.0)
+    minitest (5.25.5)
+    nokogiri (1.18.5-arm64-darwin)
+      racc (~> 1.4)
+    packwerk (3.2.2)
+      activesupport (>= 6.0)
+      ast
+      better_html
+      bundler
+      constant_resolver (>= 0.2.0)
+      parallel
+      parser
+      prism (>= 0.25.0)
+      sorbet-runtime (>= 0.5.9914)
+      zeitwerk (>= 2.6.1)
+    parallel (1.26.3)
+    parse_packwerk (0.26.0)
+      bigdecimal
+      sorbet-runtime
+    parser (3.3.7.2)
+      ast (~> 2.4.1)
+      racc
+    pp (0.6.2)
+      prettyprint
+    prettyprint (0.2.0)
+    prism (1.4.0)
+    psych (5.2.3)
+      date
+      stringio
+    public_suffix (6.0.1)
+    racc (1.8.1)
+    rails-dom-testing (2.2.0)
+      activesupport (>= 5.0.0)
+      minitest
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.6.2)
+      loofah (~> 2.21)
+      nokogiri (>= 1.15.7, != 1.16.7, != 1.16.6, != 1.16.5, != 1.16.4, != 1.16.3, != 1.16.2, != 1.16.1, != 1.16.0.rc1, != 1.16.0)
+    rainbow (3.1.1)
+    rake (13.2.1)
+    rdoc (6.12.0)
+      psych (>= 4.0.0)
+    regexp_parser (2.10.0)
+    reline (0.6.0)
+      io-console (~> 0.5)
+    rspec (3.13.0)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.3)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.2)
+    rubocop (1.74.0)
+      json (~> 2.3)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.1.0)
+      parallel (~> 1.10)
+      parser (>= 3.3.0.2)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 2.9.3, < 3.0)
+      rubocop-ast (>= 1.38.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 4.0)
+    rubocop-ast (1.41.0)
+      parser (>= 3.3.7.2)
+    rubocop-performance (1.24.0)
+      lint_roller (~> 1.1)
+      rubocop (>= 1.72.1, < 2.0)
+      rubocop-ast (>= 1.38.0, < 2.0)
+    rubocop-sorbet (0.9.0)
+      lint_roller (~> 1.1)
+      rubocop (>= 1)
+    ruby-progressbar (1.13.0)
+    securerandom (0.4.1)
+    smart_properties (1.17.0)
+    sorbet (0.5.11953)
+      sorbet-static (= 0.5.11953)
+    sorbet-runtime (0.5.11953)
+    sorbet-static (0.5.11953-universal-darwin)
+    stringio (3.1.5)
+    thor (1.3.2)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (3.1.4)
+      unicode-emoji (~> 4.0, >= 4.0.4)
+    unicode-emoji (4.0.4)
+    uri (1.0.3)
+    zeitwerk (2.7.2)
+
+PLATFORMS
+  arm64-darwin
+  universal-darwin
+
+DEPENDENCIES
+  chatwerk!
+  irb
+  mcp-rb!
+  query_packwerk!
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop (~> 1.21)
+  rubocop-performance
+  rubocop-sorbet
+  sorbet (~> 0.5)
+
+BUNDLED WITH
+   2.6.6

MCP.md

@@ -0,0 +1,81 @@
+# QueryPackwerk MCP Server
+
+The QueryPackwerk MCP (Model Context Protocol) server enables integration with Cursor IDE and other AI tools that support the MCP protocol. This allows you to get information about Packwerk packages and violations directly in your IDE.
+
+## Installation
+
+The MCP server requires additional dependencies. Make sure to install the gem with the development dependencies:
+
+```bash
+gem install query_packwerk --development
+```
+
+Or in your Gemfile:
+
+```ruby
+gem 'query_packwerk', group: :development
+```
+
+## Starting the MCP Server
+
+You can start the MCP server using the provided command:
+
+```bash
+query_packwerk_mcp
+```
+
+By default, the server runs on port 7531. You can specify a different port:
+
+```bash
+query_packwerk_mcp --port=9000
+```
+
+## Connecting with Cursor
+
+To use QueryPackwerk with Cursor:
+
+1. Start the MCP server in your project directory:
+   ```bash
+   cd /your/rails/project
+   query_packwerk_mcp
+   ```
+
+2. In Cursor, open Settings > Extensions > Model Context Providers.
+
+3. Add a new MCP connection with the URL: `http://localhost:7531/mcp/context`
+
+4. Now you can ask Cursor about your packages and violations!
+
+## Example Queries for Cursor
+
+Once connected, you can ask Cursor questions about your Packwerk structure:
+
+- "What are all the packages in this codebase?"
+- "Tell me about the dependencies of package X"
+- "What packages depend on package Y?"
+- "Show me all the violations for package Z"
+- "How difficult would it be to separate package X from its dependencies?"
+- "What code patterns are used to access package Y?"
+
+## Available API Endpoints
+
+The MCP server also provides a REST API that you can use directly:
+
+- `GET /api/packages` - List all packages
+- `GET /api/packages/search?q=query` - Search packages by name/owner
+- `GET /api/packages/:name/info` - Get detailed info about a package
+- `GET /api/packages/:name/dependencies` - Get dependencies of a package
+- `GET /api/packages/:name/consumers` - Get consumers of a package
+- `GET /api/packages/:name/usage-patterns` - Get usage patterns of a package
+- `GET /api/packages/:name/access-patterns` - Get access patterns with examples
+- `GET /api/packages/:name/usage-locations` - Find where a package is used
+- `GET /api/packages/:name/separation-difficulty` - Assess difficulty of separating a package
+
+## MCP Protocol Integration
+
+The MCP server supports the following capabilities:
+
+- `packwerk-packages` - Access information about packages
+- `packwerk-violations` - Access information about violations
+
+These capabilities are available through the standard MCP context endpoint at `/mcp/context`.