Make it easier to run the inspector

Author: martinemde

README.md

@@ -4,19 +4,14 @@ Chatwerk provides AI tool integration for the [QueryPackwerk](https://github.com
 
 ## Installation
 
-Install the gem and add to your application's Gemfile:
+Install the gem, either add in to your packwerk'd application's Gemfile:
 
 ```ruby
-gem 'chatwerk', group: :development
-```
-
-And then execute:
-
-```bash
+$ bundle add chatwerk
 $ bundle install
 ```
 
-Or install it yourself:
+or install it on its own:
 
 ```bash
 $ gem install chatwerk
@@ -26,33 +21,23 @@ $ gem install chatwerk
 
 ### Starting the MCP Server
 
-Start the MCP server in your Rails application directory:
-
-```bash
-$ chatwerk_mcp
-```
-
-By default, the server runs on port 7531. You can specify a different port:
+You can test the inspector to see if it's working
 
 ```bash
-$ chatwerk_mcp --port=9000
+$ chatwerk inspect
 ```
 
 ### Connecting with Cursor IDE
 
 To use Chatwerk with Cursor:
 
-1. Start the MCP server in your project directory:
-   ```bash
-   cd /your/rails/project
-   chatwerk_mcp
-   ```
+1. In Cursor, open Settings > MCP
 
-2. In Cursor, open Settings > Extensions > Model Context Providers.
+2. Add a new MCP connection as a command
+   Name: `chatwerk`
+   Command: `chatwerk mcp`
 
-3. Add a new MCP connection with the URL: `http://localhost:7531/mcp/context`
-
-4. Now you can ask Cursor questions about your Packwerk structure!
+3. Ask Cursor to check all the tools on packwerk. Give it an example pack name (partial strings work)
 
 ### Example Queries for Cursor
 
@@ -63,31 +48,13 @@ Once connected, you can ask Cursor questions about your Packwerk structure:
 - "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?"
-
-## API Reference
-
-Chatwerk provides a structured API for accessing Packwerk information. This API powers the MCP server but can also be used directly in your Ruby code:
-
-```ruby
-require 'chatwerk'
-
-# Get detailed information about a package
-Chatwerk::API.package_info('packs/my_package')
-
-# Get dependencies of a package
-Chatwerk::API.package_dependencies('packs/my_package')
-
-# Find usage locations of a package
-Chatwerk::API.find_usage_locations('packs/my_package')
-
-# Assess difficulty of separating a package
-Chatwerk::API.assess_separation_difficulty('packs/my_package')
-```
+- "What code patterns are used to access Constant on package Y?"
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests.
+
+Run `bin/inspect`
 
 ## Contributing
 

bin/inspect

@@ -1,3 +1,7 @@
 #!/bin/bash
 
-npx @modelcontextprotocol/inspector bundle exec exe/chatwerk mcp
+if [ -n "$1" ]; then
+  npx @modelcontextprotocol/inspector -e PWD="$1" bundle exec exe/chatwerk mcp
+else
+  npx @modelcontextprotocol/inspector bundle exec exe/chatwerk mcp
+fi

lib/chatwerk/cli.rb

@@ -14,6 +14,12 @@ def mcp
       MCP::Server.new(Chatwerk::Mcp.new).serve(MCP::Server::StdioClientConnection.new)
     end
 
+    desc 'inspect [WORKING_DIRECTORY]', 'Run the MCP inspector with an optional working directory path (defaults to current directory)'
+    def inspect(working_directory = nil)
+      pwd = working_directory || Dir.pwd
+      system("npx @modelcontextprotocol/inspector -e PWD=#{pwd} bundle exec exe/chatwerk mcp")
+    end
+
     desc 'version', 'Display Chatwerk version'
     def version
       puts "Chatwerk #{Chatwerk::VERSION}"