simplecov-mcp 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 06e96d273c6549d1f0539baa88ec863009f263e6d9f214c66157ac5e708b51a5
-  data.tar.gz: fc1503a39a31d19076f4e7827aad1d1996fd4760b381aafdf7e4b13f8891fb0c
+  metadata.gz: '08e9a29ca4d2e2daafd4620690021de136eaa2cfc2ba652340f73d8b69547d8d'
+  data.tar.gz: 784e8ef1f21e6ed4e37783a840935e909d8a6d1f6ae4c941da34d0e6635f9f95
 SHA512:
-  metadata.gz: 41125a954fca4422327a821f18ad55b8de0d473ea3c3d67bc0bb9eb6105d81aa09efcab262a09f0cedeb809adb73a0e974b36d0dcf00ceff55af8e639a573afe
-  data.tar.gz: 7ab8e6375e1645557a8dd30c72be8e37e9d4fd97de59e330db24c0f6ec92339db5488b43c5cc9dbc975edbf5184fdb3179d5425cb48d5791d2fb0650659ab439
+  metadata.gz: 52e2a95fda335f611f38cd0b97164a62e381532ceb71b330c32023be10eeb8d97e999bdc32f0dafac168f0470cac481151e78f223623e90a377fe79ef807705b
+  data.tar.gz: 42ce8d9f01b069f2e3dd0d0e817cd135298fa14d06553ef5b0771d37baf9f5bd4c194d9a9296a823966da21ec505e69b41fd489dfcfa1b0e0b74bb63949b7a21

data/README.md

@@ -92,6 +92,12 @@ echo '{"jsonrpc":"2.0","id":2,"method":"tools/call","params":{"name":"all_files_
 
 Tip: In an MCP-capable editor/agent, configure `simplecov-mcp` as a stdio server and call the same tool names with the `arguments` shown above.
 
+Response content types (MCP):
+
+- JSON data returns as a single `type: "resource"` item with `resource.mimeType: "application/json"` and the JSON string in `resource.text` (e.g., `name: "coverage_summary.json"`).
+- Human-readable strings (e.g., the table and version) return as `type: "text"`.
+- Errors return as `type: "text"` with a friendly message.
+
 Resultset resolution:
 
 - If `resultset:` is provided, it may be:
@@ -120,7 +126,7 @@ Using simplecov-mcp, show me a table of all files and their coverages.
 
 ----
 
-Using simplecov-mcp, find the uncovered code lines and report to me:
+Using simplecov-mcp, find the uncovered code lines and report to me, in a markdown file:
 
 * the most important coverage omissions to address
 * the simplest coverage omissions to address
@@ -348,6 +354,11 @@ Available tools:
   - Returns `{ files: [{"file","covered","total","percentage","stale"}, ...] }` where `stale` is a boolean.
 - `version_tool()` — returns version information
 
+Response shape and content types:
+
+- JSON tools above return a single content item `{ "type": "resource", "resource": { "mimeType": "application/json", "text": "{...}", "name": "<tool>.json" } }`.
+- `coverage_table_tool` and `version_tool` return `{ "type": "text", "text": "..." }`.
+
 Notes:
 
 - `resultset` lets clients pass a nonstandard path to `.resultset.json` directly (absolute or relative to `root`). It may be:

data/lib/simple_cov_mcp/base_tool.rb

@@ -44,6 +44,22 @@ module SimpleCovMcp
         ::MCP::Tool::Response.new([{ type: 'text', text: "Error: #{normalized.user_friendly_message}" }])
       end
 
+      # Respond with JSON as a resource to avoid clients mutating content types.
+      # The resource embeds the JSON string with a clear MIME type.
+      def self.respond_json(payload, name: 'data.json', pretty: false)
+        json = pretty ? JSON.pretty_generate(payload) : JSON.generate(payload)
+        ::MCP::Tool::Response.new([
+          {
+            'type' => 'resource',
+            'resource' => {
+              'mimeType' => 'application/json',
+              'text' => json,
+              'name' => name
+            }
+          }
+        ])
+      end
+
       private
 
       def self.log_mcp_error(error, tool_name)

data/lib/simple_cov_mcp/tools/all_files_coverage_tool.rb

@@ -53,7 +53,7 @@ module SimpleCovMcp
           stale_count = files.count { |f| f['stale'] }
           ok_count = total - stale_count
           payload = { files: files, counts: { total: total, ok: ok_count, stale: stale_count } }
-          ::MCP::Tool::Response.new([{ type: 'text', text: JSON.pretty_generate(payload) }])
+          respond_json(payload, name: 'all_files_coverage.json')
         rescue => e
           handle_mcp_error(e, 'AllFilesCoverageTool')
         end

data/lib/simple_cov_mcp/tools/coverage_detailed_tool.rb

@@ -19,7 +19,7 @@ module SimpleCovMcp
           mode = stale
           model = CoverageModel.new(root: root, resultset: resultset, staleness: mode)
           data = model.detailed_for(path)
-          ::MCP::Tool::Response.new([{ type: 'text', text: JSON.pretty_generate(data) }])
+          respond_json(data, name: 'coverage_detailed.json', pretty: true)
         rescue => e
           handle_mcp_error(e, 'CoverageDetailedTool')
         end

data/lib/simple_cov_mcp/tools/coverage_raw_tool.rb

@@ -19,7 +19,7 @@ module SimpleCovMcp
           mode = stale
           model = CoverageModel.new(root: root, resultset: resultset, staleness: mode)
           data = model.raw_for(path)
-          ::MCP::Tool::Response.new([{ type: 'text', text: JSON.pretty_generate(data) }])
+          respond_json(data, name: 'coverage_raw.json', pretty: true)
         rescue => e
           handle_mcp_error(e, 'CoverageRawTool')
         end

data/lib/simple_cov_mcp/tools/coverage_summary_tool.rb

@@ -19,7 +19,7 @@ module SimpleCovMcp
           mode = stale
           model = CoverageModel.new(root: root, resultset: resultset, staleness: mode)
           data = model.summary_for(path)
-          ::MCP::Tool::Response.new([{ type: 'text', text: JSON.pretty_generate(data) }])
+          respond_json(data, name: 'coverage_summary.json', pretty: true)
         rescue => e
           handle_mcp_error(e, 'CoverageSummaryTool')
         end

data/lib/simple_cov_mcp/tools/help_tool.rb

@@ -88,7 +88,8 @@ module SimpleCovMcp
           entries = TOOL_GUIDE.map { |guide| format_entry(guide) }
           entries = filter_entries(entries, query) if query && !query.strip.empty?
 
-          ::MCP::Tool::Response.new([{ type: 'text', text: JSON.pretty_generate({ query: query, tools: entries }) }])
+          data = { query: query, tools: entries }
+          respond_json(data, name: 'tools_help.json')
         rescue => e
           handle_mcp_error(e, 'HelpTool')
         end

data/lib/simple_cov_mcp/tools/uncovered_lines_tool.rb

@@ -19,7 +19,7 @@ module SimpleCovMcp
           mode = stale
           model = CoverageModel.new(root: root, resultset: resultset, staleness: mode)
           data = model.uncovered_for(path)
-          ::MCP::Tool::Response.new([{ type: 'text', text: JSON.pretty_generate(data) }])
+          respond_json(data, name: 'uncovered_lines.json', pretty: true)
         rescue => e
           handle_mcp_error(e, 'UncoveredLinesTool')
         end

data/lib/simple_cov_mcp/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SimpleCovMcp
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'
 end

data/spec/all_files_coverage_tool_spec.rb

@@ -28,11 +28,13 @@ RSpec.describe SimpleCovMcp::Tools::AllFilesCoverageTool do
 
     response = described_class.call(root: root, server_context: server_context)
     entry = response.payload.first
-    json = entry[:json] || entry['json']
+    expect(entry['type']).to eq('resource')
+    expect(entry['resource']).to include('mimeType' => 'application/json')
+    json = JSON.parse(entry['resource']['text'])
 
-    expect(json).to have_key(:files).or have_key('files')
-    files = json[:files] || json['files']
-    counts = json[:counts] || json['counts']
+    expect(json).to have_key('files')
+    files = json['files']
+    counts = json['counts']
 
     expect(files.length).to eq(2)
     expect(counts).to include('total' => 2).or include(total: 2)

data/spec/coverage_detailed_tool_spec.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+require 'simple_cov_mcp/tools/coverage_detailed_tool'
+
+RSpec.describe SimpleCovMcp::Tools::CoverageDetailedTool do
+  let(:server_context) { instance_double('ServerContext').as_null_object }
+
+  before do
+    stub_const('MCP::Tool::Response', Struct.new(:payload))
+  end
+
+  it 'returns JSON as an application/json resource' do
+    model = instance_double(SimpleCovMcp::CoverageModel)
+    allow(SimpleCovMcp::CoverageModel).to receive(:new).and_return(model)
+    allow(model).to receive(:detailed_for).with('lib/foo.rb').and_return(
+      {
+        'file' => '/abs/path/lib/foo.rb',
+        'lines' => [
+          { 'line' => 1, 'hits' => 1, 'covered' => true },
+          { 'line' => 2, 'hits' => 0, 'covered' => false }
+        ],
+        'summary' => { 'covered' => 1, 'total' => 2, 'pct' => 50.0 }
+      }
+    )
+
+    response = described_class.call(path: 'lib/foo.rb', server_context: server_context)
+    item = response.payload.first
+    expect(item['type']).to eq('resource')
+    expect(item['resource']).to include('mimeType' => 'application/json', 'name' => 'coverage_detailed.json')
+    data = JSON.parse(item['resource']['text'])
+    expect(data).to include('file', 'lines', 'summary')
+    expect(data['lines']).to be_an(Array)
+  end
+end
+

data/spec/coverage_raw_tool_spec.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+require 'simple_cov_mcp/tools/coverage_raw_tool'
+
+RSpec.describe SimpleCovMcp::Tools::CoverageRawTool do
+  let(:server_context) { instance_double('ServerContext').as_null_object }
+
+  before do
+    stub_const('MCP::Tool::Response', Struct.new(:payload))
+  end
+
+  it 'returns JSON as an application/json resource' do
+    model = instance_double(SimpleCovMcp::CoverageModel)
+    allow(SimpleCovMcp::CoverageModel).to receive(:new).and_return(model)
+    allow(model).to receive(:raw_for).with('lib/foo.rb').and_return(
+      {
+        'file' => '/abs/path/lib/foo.rb',
+        'lines' => [nil, 1, 0]
+      }
+    )
+
+    response = described_class.call(path: 'lib/foo.rb', server_context: server_context)
+    item = response.payload.first
+    expect(item['type']).to eq('resource')
+    expect(item['resource']).to include('mimeType' => 'application/json', 'name' => 'coverage_raw.json')
+    data = JSON.parse(item['resource']['text'])
+    expect(data).to include('file', 'lines')
+    expect(data['lines']).to be_an(Array)
+  end
+end
+

data/spec/coverage_summary_tool_spec.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+require 'simple_cov_mcp/tools/coverage_summary_tool'
+
+RSpec.describe SimpleCovMcp::Tools::CoverageSummaryTool do
+  let(:server_context) { instance_double('ServerContext').as_null_object }
+
+  before do
+    response_class = Class.new do
+      attr_reader :payload, :meta
+      def initialize(payload, meta: nil)
+        @payload = payload
+        @meta = meta
+      end
+    end
+    stub_const('MCP::Tool::Response', response_class)
+  end
+
+  it 'returns JSON as an application/json resource' do
+    model = instance_double(SimpleCovMcp::CoverageModel)
+    allow(SimpleCovMcp::CoverageModel).to receive(:new).and_return(model)
+    allow(model).to receive(:summary_for).with('lib/foo.rb').and_return(
+      {
+        'file' => '/abs/path/lib/foo.rb',
+        'summary' => { 'covered' => 10, 'total' => 12, 'pct' => 83.33 }
+      }
+    )
+
+    response = described_class.call(path: 'lib/foo.rb', server_context: server_context)
+    item = response.payload.first
+    expect(item['type']).to eq('resource')
+    expect(item['resource']).to include('mimeType' => 'application/json', 'name' => 'coverage_summary.json')
+    data = JSON.parse(item['resource']['text'])
+    expect(data).to include('file', 'summary')
+    expect(data['summary']).to include('covered', 'total', 'pct')
+  end
+end
+

data/spec/help_tool_spec.rb

@@ -10,9 +10,9 @@ RSpec.describe SimpleCovMcp::Tools::HelpTool do
     response_class = Class.new do
       attr_reader :payload, :meta
 
-      def initialize(payload, meta: nil)
+      def initialize(payload)
         @payload = payload
-        @meta = meta
+        @meta = nil
       end
     end
     stub_const('MCP::Tool::Response', response_class)
@@ -20,28 +20,29 @@ RSpec.describe SimpleCovMcp::Tools::HelpTool do
 
   it 'returns guidance for each registered tool' do
     response = described_class.call(server_context: server_context)
-    expect(response.meta[:mimeType]).to eq('application/json')
+    expect(response.meta).to be_nil
 
     payload = response.payload.first
-    expect(payload[:type]).to eq('json')
-
-    data = payload[:json]
-    tool_names = data[:tools].map { |entry| entry['tool'] }
+    expect(payload['type']).to eq('resource')
+    expect(payload['resource']).to include('mimeType' => 'application/json')
+    data = JSON.parse(payload['resource']['text'])
+    tool_names = data['tools'].map { |entry| entry['tool'] }
 
     expect(tool_names).to include('coverage_summary_tool', 'uncovered_lines_tool', 'all_files_coverage_tool', 'coverage_table_tool', 'version_tool')
-    expect(data[:tools]).to all(include('use_when', 'avoid_when', 'inputs', 'example'))
+    expect(data['tools']).to all(include('use_when', 'avoid_when', 'inputs', 'example'))
   end
 
   it 'filters entries when a query is provided' do
     response = described_class.call(query: 'uncovered', server_context: server_context)
     payload = response.payload.first
-    data = payload[:json]
+    expect(payload['type']).to eq('resource')
+    data = JSON.parse(payload['resource']['text'])
 
-    expect(data[:tools]).not_to be_empty
-    expect(data[:tools]).to all(satisfy do |entry|
+    expect(data['tools']).not_to be_empty
+    expect(data['tools']).to all(satisfy do |entry|
       combined = [entry['tool'], entry['label'], entry['use_when'], entry['avoid_when']].compact.join(' ').downcase
       combined.include?('uncovered')
     end)
-    expect(data[:tools].map { |entry| entry['tool'] }).to include('uncovered_lines_tool')
+    expect(data['tools'].map { |entry| entry['tool'] }).to include('uncovered_lines_tool')
   end
 end

data/spec/uncovered_lines_tool_spec.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+require 'simple_cov_mcp/tools/uncovered_lines_tool'
+
+RSpec.describe SimpleCovMcp::Tools::UncoveredLinesTool do
+  let(:server_context) { instance_double('ServerContext').as_null_object }
+
+  before do
+    stub_const('MCP::Tool::Response', Struct.new(:payload))
+  end
+
+  it 'returns JSON as an application/json resource' do
+    model = instance_double(SimpleCovMcp::CoverageModel)
+    allow(SimpleCovMcp::CoverageModel).to receive(:new).and_return(model)
+    allow(model).to receive(:uncovered_for).with('lib/foo.rb').and_return(
+      {
+        'file' => '/abs/path/lib/foo.rb',
+        'uncovered' => [5, 9, 12],
+        'summary' => { 'covered' => 10, 'total' => 12, 'pct' => 83.33 }
+      }
+    )
+
+    response = described_class.call(path: 'lib/foo.rb', server_context: server_context)
+    item = response.payload.first
+    expect(item['type']).to eq('resource')
+    expect(item['resource']).to include('mimeType' => 'application/json', 'name' => 'uncovered_lines.json')
+    data = JSON.parse(item['resource']['text'])
+    expect(data).to include('file', 'uncovered', 'summary')
+    expect(data['uncovered']).to eq([5, 9, 12])
+  end
+end
+

data/spec/version_spec.rb

@@ -5,6 +5,11 @@ require 'spec_helper'
 RSpec.describe 'Version constant' do
   it 'exposes a semver-like version string' do
     expect(SimpleCovMcp::VERSION).to be_a(String)
-    expect(SimpleCovMcp::VERSION).to match(/\A\d+\.\d+\.\d+(?:[.-][0-9A-Za-z]+)?\z/)
+    # Named fragments for readability (simplified SemVer)
+    CORE  = /\d+\.\d+\.\d+/
+    ID    = /[[:alnum:].-]+/            # ASCII alnum plus dot/hyphen
+    SEMVER = /\A#{CORE.source}(?:-#{ID.source})?(?:\+#{ID.source})?\z/
+
+    expect(SimpleCovMcp::VERSION).to match(SEMVER)
   end
 end

data/spec/version_tool_spec.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+require 'simple_cov_mcp/tools/version_tool'
+
+RSpec.describe SimpleCovMcp::Tools::VersionTool do
+  let(:server_context) { instance_double('ServerContext').as_null_object }
+
+  before do
+    stub_const('MCP::Tool::Response', Struct.new(:payload))
+  end
+
+  it 'returns a text payload with the version string' do
+    response = described_class.call(server_context: server_context)
+    item = response.payload.first
+    expect(item[:type] || item['type']).to eq('text')
+    text = item[:text] || item['text']
+    expect(text).to include('SimpleCovMcp version:')
+    expect(text).to include(SimpleCovMcp::VERSION)
+  end
+end
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: simplecov-mcp
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Keith R. Bennett
@@ -13,16 +13,16 @@ dependencies:
   name: mcp
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: '0.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: '0.3'
 - !ruby/object:Gem::Dependency
   name: awesome_print
   requirement: !ruby/object:Gem::Requirement
@@ -106,11 +106,13 @@ files:
 - spec/all_files_coverage_tool_spec.rb
 - spec/base_tool_spec.rb
 - spec/cli_error_spec.rb
-- spec/cli_json_source_spec.rb
 - spec/cli_source_spec.rb
 - spec/cli_spec.rb
 - spec/cli_table_spec.rb
 - spec/cli_usage_spec.rb
+- spec/coverage_detailed_tool_spec.rb
+- spec/coverage_raw_tool_spec.rb
+- spec/coverage_summary_tool_spec.rb
 - spec/coverage_table_tool_spec.rb
 - spec/error_handler_spec.rb
 - spec/errors_stale_spec.rb
@@ -123,8 +125,10 @@ files:
 - spec/simplecov_mcp_model_spec.rb
 - spec/spec_helper.rb
 - spec/staleness_more_spec.rb
+- spec/uncovered_lines_tool_spec.rb
 - spec/util_spec.rb
 - spec/version_spec.rb
+- spec/version_tool_spec.rb
 homepage: https://github.com/keithrbennett/simplecov-mcp
 licenses:
 - MIT

data/spec/cli_json_source_spec.rb

@@ -1,92 +0,0 @@
-# frozen_string_literal: true
-
-require 'spec_helper'
-
-RSpec.describe SimpleCovMcp::CoverageCLI do
-  let(:root) { (FIXTURES / 'project1').to_s }
-
-  def run_cli_json(*argv)
-    cli = described_class.new
-    out = nil
-    silence_output do |stdout, _stderr|
-      cli.run(argv.flatten)
-      out = stdout.string
-    end
-    JSON.parse(out)
-  end
-
-  it 'includes source rows in JSON for summary --source=full' do
-    data = run_cli_json('summary', 'lib/foo.rb', '--root', root, '--resultset', 'coverage', '--json', '--source=full')
-    expect(data['file']).to eq('lib/foo.rb')
-    expect(data['source']).to be_an(Array)
-    expect(data['source'].first).to include('line', 'code', 'hits', 'covered')
-  end
-
-  it 'includes source rows in JSON for uncovered --source=uncovered' do
-    data = run_cli_json('uncovered', 'lib/foo.rb', '--root', root, '--resultset', 'coverage', '--json', '--source=uncovered', '--source-context', '1')
-    expect(data['file']).to eq('lib/foo.rb')
-    expect(data['source']).to be_an(Array)
-    # Only a subset of lines around uncovered should appear
-    lines = data['source'].map { |h| h['line'] }
-    expect(lines).to include(2) # the uncovered line
-  end
-
-  it 'includes source rows in JSON for detailed --source=full' do
-    data = run_cli_json('detailed', 'lib/foo.rb', '--root', root, '--resultset', 'coverage', '--json', '--source=full')
-    expect(data['file']).to eq('lib/foo.rb')
-    expect(data['lines']).to be_an(Array)
-    expect(data['source']).to be_an(Array)
-  end
-
-  it 'renders uncovered source with various context sizes without error' do
-    [0, -5, 50].each do |ctx|
-      out, err, status = begin
-        cli = described_class.new
-        s = nil
-        o = e = nil
-        silence_output do |stdout, stderr|
-          begin
-            cli.run(['uncovered', 'lib/foo.rb', '--root', root, '--resultset', 'coverage', '--source=uncovered', '--source-context', ctx.to_s, '--no-color'])
-            s = 0
-          rescue SystemExit => ex
-            s = ex.status
-          end
-          o = stdout.string
-          e = stderr.string
-        end
-        [o, e, s]
-      end
-      expect(status).to eq(0)
-      expect(err).to eq("")
-      expect(out).to include('File: lib/foo.rb')
-      expect(out).to include('Uncovered lines: 2')
-    end
-  end
-
-  it 'respects --color and --no-color for source rendering' do
-    # Force color on
-    out_color = begin
-      cli = described_class.new
-      silence_output do |stdout, _stderr|
-        cli.run(['summary', 'lib/foo.rb', '--root', root, '--resultset', 'coverage', '--source', '--color'])
-        stdout.string
-      end
-    end
-    # If source table is rendered, it should contain ANSI escapes when color is on
-    if out_color.include?('Line') && out_color.include?('|')
-      expect(out_color).to match(/\e\[\d+m/)
-    else
-      expect(out_color).to include('[source not available]')
-    end
-
-    # Force color off: expect no ANSI sequences
-    out_nocolor = begin
-      cli = described_class.new
-      silence_output do |stdout, _stderr|
-        cli.run(['summary', 'lib/foo.rb', '--root', root, '--resultset', 'coverage', '--source', '--no-color'])
-        stdout.string
-      end
-    end
-    expect(out_nocolor).not_to match(/\e\[\d+m/)
-  end
-end