mcp-server-diff 2.1.0 → 2.1.5

package/.github/workflows/release.yml

@@ -1,51 +0,0 @@
-name: Create Release
-
-on:
-  push:
-    tags:
-      - 'v[0-9]+.[0-9]+.[0-9]+'
-      - 'v[0-9]+.[0-9]+.[0-9]+-*'
-
-permissions:
-  contents: write
-
-jobs:
-  release:
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v6
-        with:
-          fetch-depth: 0
-
-      - name: Generate Release Notes
-        id: release_notes
-        run: |
-          # Get the previous tag
-          PREV_TAG=$(git describe --tags --abbrev=0 HEAD^ 2>/dev/null || echo "")
-          
-          if [ -z "$PREV_TAG" ]; then
-            echo "notes=Initial release" >> $GITHUB_OUTPUT
-          else
-            # Generate changelog from commits
-            NOTES=$(git log --pretty=format:"- %s" $PREV_TAG..HEAD | head -50)
-            echo "notes<<EOF" >> $GITHUB_OUTPUT
-            echo "$NOTES" >> $GITHUB_OUTPUT
-            echo "EOF" >> $GITHUB_OUTPUT
-          fi
-
-      - name: Create Release
-        uses: softprops/action-gh-release@v2
-        with:
-          name: ${{ github.ref_name }}
-          body: |
-            ## What's Changed
-            
-            ${{ steps.release_notes.outputs.notes }}
-            
-            ---
-            
-            **Full Changelog**: https://github.com/${{ github.repository }}/compare/${{ steps.release_notes.outputs.prev_tag || 'initial' }}...${{ github.ref_name }}
-          draft: false
-          prerelease: ${{ contains(github.ref_name, '-') }}
-          generate_release_notes: true

package/.prettierignore

@@ -1,3 +0,0 @@
-dist/
-node_modules/
-*.md

package/.prettierrc

@@ -1,8 +0,0 @@
-{
-  "semi": true,
-  "singleQuote": false,
-  "tabWidth": 2,
-  "trailingComma": "es5",
-  "printWidth": 100,
-  "bracketSpacing": true
-}

package/CONTRIBUTING.md

@@ -1,81 +0,0 @@
-# Contributing to MCP Server Diff
-
-Thank you for your interest in contributing! This document provides guidelines for contributing to MCP Server Diff.
-
-## How to Contribute
-
-### Reporting Bugs
-
-1. Check existing issues to avoid duplicates
-2. Use the bug report template
-3. Include:
-   - Steps to reproduce
-   - Expected vs actual behavior
-   - Environment details (OS, language runtime versions)
-   - Workflow configuration
-
-### Suggesting Features
-
-1. Open a feature request issue
-2. Describe the use case
-3. Explain how it benefits MCP server developers
-
-### Pull Requests
-
-1. Fork the repository
-2. Create a feature branch from `main`
-3. Make your changes
-4. Test thoroughly
-5. Submit a PR with a clear description
-
-## Development Setup
-
-### Prerequisites
-
-- Node.js 20+
-- npm
-- Git
-
-### Building
-
-```bash
-# Install dependencies
-npm ci
-
-# Run tests
-npm test
-
-# Type check, lint, and format
-npm run check
-
-# Build the action
-npm run build
-```
-
-### Testing Locally
-
-To test the action locally, you can run the built action directly:
-
-```bash
-# Build the action
-npm run build
-
-# Set environment variables that mimic GitHub Actions inputs
-export INPUT_INSTALL_COMMAND="npm ci"
-export INPUT_BUILD_COMMAND="npm run build"
-export INPUT_START_COMMAND="node dist/stdio.js"
-
-# Run the action
-node dist/index.js
-```
-
-## Code Style
-
-- TypeScript with strict mode
-- ESLint for linting
-- Prettier for formatting
-- Run `npm run check` before submitting PRs
-
-## License
-
-By contributing, you agree that your contributions will be licensed under the MIT License.

package/action.yml

@@ -1,250 +0,0 @@
-name: 'MCP Server Diff'
-description: 'Diff MCP server public interfaces between versions'
-author: 'Sam Morrow'
-branding:
-  icon: 'check-circle'
-  color: 'green'
-
-inputs:
-  # Language setup (optional convenience)
-  setup_node:
-    description: 'Set up Node.js environment'
-    required: false
-    default: 'false'
-  node_version:
-    description: 'Node.js version (default: 20)'
-    required: false
-    default: '20'
-  setup_python:
-    description: 'Set up Python environment'
-    required: false
-    default: 'false'
-  python_version:
-    description: 'Python version (default: 3.11)'
-    required: false
-    default: '3.11'
-  setup_go:
-    description: 'Set up Go environment'
-    required: false
-    default: 'false'
-  go_version:
-    description: 'Go version (default: read from go.mod)'
-    required: false
-    default: ''
-  setup_rust:
-    description: 'Set up Rust environment'
-    required: false
-    default: 'false'
-  rust_toolchain:
-    description: 'Rust toolchain (default: stable)'
-    required: false
-    default: 'stable'
-  setup_dotnet:
-    description: 'Set up .NET environment'
-    required: false
-    default: 'false'
-  dotnet_version:
-    description: '.NET version (default: 8.0.x)'
-    required: false
-    default: '8.0.x'
-
-  # Build configuration
-  install_command:
-    description: 'Command to install dependencies (optional if no install step needed)'
-    required: false
-    default: ''
-  build_command:
-    description: 'Command to build the MCP server (optional for interpreted languages)'
-    required: false
-    default: ''
-  start_command:
-    description: 'Command to start the MCP server (for stdio transport, or to start HTTP server)'
-    required: false
-    default: ''
-
-  # Transport configuration
-  transport:
-    description: 'Transport type: stdio or streamable-http'
-    required: false
-    default: 'stdio'
-  server_url:
-    description: 'Server URL for HTTP transport (e.g., http://localhost:3000/mcp)'
-    required: false
-    default: ''
-  configurations:
-    description: |
-      JSON array of test configurations for multiple transports/scenarios. 
-      Each object supports: name, transport, start_command, args, server_url, headers, env_vars, custom_messages.
-      
-      For HTTP transport, use start_command to have the action manage server lifecycle:
-        - start_command: Command to start the server (action spawns, probes, then kills it)
-        - startup_wait_ms: Milliseconds to wait for server startup (default: 2000)
-      
-      Or use pre/post commands for manual control:
-        - pre_test_command: Command to run before probing (e.g., start server in background)
-        - pre_test_wait_ms: Milliseconds to wait after pre_test_command
-        - post_test_command: Command to run after probing (e.g., kill server process)
-    required: false
-    default: ''
-  custom_messages:
-    description: 'JSON array of custom JSON-RPC messages to send. Each object: id (number), name (string), message (JSON-RPC object). Applied to all configurations unless overridden per-config.'
-    required: false
-    default: ''
-  headers:
-    description: 'HTTP headers to send with streamable-http requests. JSON object or newline-separated "Header: value" pairs. Applied to all HTTP configurations unless overridden per-config.'
-    required: false
-    default: ''
-
-  # Test configuration
-  compare_ref:
-    description: 'Git ref to compare against (auto-detects merge-base or previous tag if not set)'
-    required: false
-    default: ''
-  fail_on_error:
-    description: 'Fail the action if probe errors occur (not just API differences)'
-    required: false
-    default: 'true'
-  fail_on_diff:
-    description: 'Fail the action if API differences are detected (useful for release validation)'
-    required: false
-    default: 'false'
-  env_vars:
-    description: 'Environment variables (newline-separated KEY=VALUE pairs)'
-    required: false
-    default: ''
-  server_timeout:
-    description: 'Timeout in seconds to wait for server response'
-    required: false
-    default: '10'
-
-  # Shared HTTP server (starts once, tests all HTTP configurations against it)
-  http_start_command:
-    description: |
-      Command to start a shared HTTP server for all HTTP transport configurations.
-      When set, the server starts once before all HTTP tests and stops after they complete.
-      This is more efficient than starting/stopping per-configuration.
-      Per-config start_command is ignored when this is set.
-    required: false
-    default: ''
-  http_startup_wait_ms:
-    description: 'Milliseconds to wait for shared HTTP server to start (default: 2000)'
-    required: false
-    default: '2000'
-
-outputs:
-  status:
-    description: 'Test status (passed, differences, or error)'
-    value: ${{ steps.diff.outputs.status }}
-  report_path:
-    description: 'Path to the diff report'
-    value: 'mcp-diff-report/MCP_DIFF_REPORT.md'
-
-runs:
-  using: 'composite'
-  steps:
-    # Optional language setup
-    - name: Set up Node.js
-      if: inputs.setup_node == 'true'
-      uses: actions/setup-node@6044e13b5dc448c55e2357c09f80417699197238 # v6.2.0
-      with:
-        node-version: ${{ inputs.node_version }}
-
-    - name: Set up Python
-      if: inputs.setup_python == 'true'
-      uses: actions/setup-python@83679a892e2d95755f2dac6acb0bfd1e9ac5d548 # v6.1.0
-      with:
-        python-version: ${{ inputs.python_version }}
-
-    - name: Set up Go
-      if: inputs.setup_go == 'true'
-      uses: actions/setup-go@7a3fe6cf4cb3a834922a1244abfce67bcef6a0c5 # v6.2.0
-      with:
-        go-version: ${{ inputs.go_version || null }}
-        go-version-file: ${{ inputs.go_version == '' && 'go.mod' || null }}
-
-    - name: Set up Rust
-      if: inputs.setup_rust == 'true'
-      uses: dtolnay/rust-toolchain@f7ccc83f9ed1e5b9c81d8a67d7ad1a747e22a561 # master
-      with:
-        toolchain: ${{ inputs.rust_toolchain }}
-
-    - name: Set up .NET
-      if: inputs.setup_dotnet == 'true'
-      uses: actions/setup-dotnet@baa11fbfe1d6520db94683bd5c7a3818018e4309 # v5.1.0
-      with:
-        dotnet-version: ${{ inputs.dotnet_version }}
-
-    - name: Set environment variables
-      if: inputs.env_vars != ''
-      shell: bash
-      run: |
-        echo "${{ inputs.env_vars }}" >> $GITHUB_ENV
-
-    - name: Run MCP server diff
-      id: diff
-      shell: bash
-      env:
-        INPUT_INSTALL_COMMAND: ${{ inputs.install_command }}
-        INPUT_BUILD_COMMAND: ${{ inputs.build_command }}
-        INPUT_START_COMMAND: ${{ inputs.start_command }}
-        INPUT_SERVER_TIMEOUT: ${{ inputs.server_timeout }}
-        INPUT_COMPARE_REF: ${{ inputs.compare_ref }}
-        INPUT_FAIL_ON_ERROR: ${{ inputs.fail_on_error }}
-        INPUT_TRANSPORT: ${{ inputs.transport }}
-        INPUT_SERVER_URL: ${{ inputs.server_url }}
-        INPUT_CONFIGURATIONS: ${{ inputs.configurations }}
-        INPUT_CUSTOM_MESSAGES: ${{ inputs.custom_messages }}
-        INPUT_HEADERS: ${{ inputs.headers }}
-        INPUT_ENV_VARS: ${{ inputs.env_vars }}
-        INPUT_HTTP_START_COMMAND: ${{ inputs.http_start_command }}
-        INPUT_HTTP_STARTUP_WAIT_MS: ${{ inputs.http_startup_wait_ms }}
-        INPUT_SETUP_NODE: ${{ inputs.setup_node }}
-        INPUT_NODE_VERSION: ${{ inputs.node_version }}
-        INPUT_SETUP_PYTHON: ${{ inputs.setup_python }}
-        INPUT_PYTHON_VERSION: ${{ inputs.python_version }}
-        INPUT_SETUP_GO: ${{ inputs.setup_go }}
-        INPUT_GO_VERSION: ${{ inputs.go_version }}
-        INPUT_SETUP_RUST: ${{ inputs.setup_rust }}
-        INPUT_RUST_TOOLCHAIN: ${{ inputs.rust_toolchain }}
-        INPUT_SETUP_DOTNET: ${{ inputs.setup_dotnet }}
-        INPUT_DOTNET_VERSION: ${{ inputs.dotnet_version }}
-      run: |
-        node "${{ github.action_path }}/dist/index.js"
-
-    - name: Generate Job Summary
-      shell: bash
-      run: |
-        echo "# MCP Server Diff Report" >> $GITHUB_STEP_SUMMARY
-        echo "" >> $GITHUB_STEP_SUMMARY
-        if [ -n "${{ inputs.compare_ref }}" ]; then
-          echo "Comparing against: \`${{ inputs.compare_ref }}\`" >> $GITHUB_STEP_SUMMARY
-        elif [[ "${{ github.ref }}" == refs/tags/* ]]; then
-          echo "Comparing tag against previous tag (auto-detected)" >> $GITHUB_STEP_SUMMARY
-        else
-          echo "Comparing against merge-base with \`origin/main\`" >> $GITHUB_STEP_SUMMARY
-        fi
-        echo "" >> $GITHUB_STEP_SUMMARY
-        
-        if [ -f mcp-diff-report/MCP_DIFF_REPORT.md ]; then
-          tail -n +5 mcp-diff-report/MCP_DIFF_REPORT.md >> $GITHUB_STEP_SUMMARY
-        else
-          echo "Report file not found - check the workflow logs for errors" >> $GITHUB_STEP_SUMMARY
-        fi
-        
-        echo "" >> $GITHUB_STEP_SUMMARY
-        echo "---" >> $GITHUB_STEP_SUMMARY
-        echo "" >> $GITHUB_STEP_SUMMARY
-        
-        if [ "${{ steps.diff.outputs.status }}" = "passed" ]; then
-          echo "**No API changes detected** between the branches." >> $GITHUB_STEP_SUMMARY
-        else
-          echo "**API changes detected** — review above to confirm they are expected." >> $GITHUB_STEP_SUMMARY
-        fi
-
-    - name: Upload diff report
-      if: always()
-      uses: actions/upload-artifact@b7c566a772e6b6bfb58ed0dc250532a479d7789f # v6.0.0
-      with:
-        name: mcp-diff-report
-        path: mcp-diff-report/
-        if-no-files-found: ignore

package/eslint.config.mjs

@@ -1,47 +0,0 @@
-import eslint from "@eslint/js";
-import tseslint from "typescript-eslint";
-import prettier from "eslint-config-prettier";
-
-export default tseslint.config(
-  eslint.configs.recommended,
-  ...tseslint.configs.recommended,
-  prettier,
-  {
-    languageOptions: {
-      parserOptions: {
-        project: "./tsconfig.json",
-      },
-    },
-    rules: {
-      "@typescript-eslint/no-unused-vars": [
-        "error",
-        { argsIgnorePattern: "^_", varsIgnorePattern: "^_" },
-      ],
-      "@typescript-eslint/explicit-function-return-type": "off",
-      "@typescript-eslint/no-explicit-any": "warn",
-      "no-console": "warn",
-    },
-  },
-  {
-    // Test files don't need the project reference and need Jest globals
-    files: ["**/__tests__/**/*.ts", "**/*.test.ts"],
-    languageOptions: {
-      parserOptions: {
-        project: null,
-      },
-      globals: {
-        describe: "readonly",
-        it: "readonly",
-        expect: "readonly",
-        beforeEach: "readonly",
-        afterEach: "readonly",
-        beforeAll: "readonly",
-        afterAll: "readonly",
-        jest: "readonly",
-      },
-    },
-  },
-  {
-    ignores: ["dist/**", "node_modules/**", "*.js", "*.mjs"],
-  }
-);

package/jest.config.mjs

@@ -1,26 +0,0 @@
-/** @type {import('jest').Config} */
-export default {
-  preset: "ts-jest/presets/default-esm",
-  testEnvironment: "node",
-  extensionsToTreatAsEsm: [".ts"],
-  // Force exit after tests complete - needed because npx tsx leaves handles open
-  forceExit: true,
-  moduleNameMapper: {
-    "^(\\.{1,2}/.*)\\.js$": "$1",
-  },
-  transform: {
-    "^.+\\.tsx?$": [
-      "ts-jest",
-      {
-        useESM: true,
-        diagnostics: {
-          ignoreCodes: [151002],
-        },
-      },
-    ],
-  },
-  testMatch: ["**/__tests__/**/*.test.ts", "**/*.test.ts"],
-  collectCoverageFrom: ["src/**/*.ts", "!src/**/*.d.ts"],
-  coverageDirectory: "coverage",
-  coverageReporters: ["text", "lcov", "html"],
-};

package/src/__tests__/fixtures/http-server.ts

@@ -1,103 +0,0 @@
-#!/usr/bin/env npx tsx
-/**
- * Minimal MCP Server for integration testing (streamable-http transport)
- *
- * Run with: npx tsx http-server.ts <port>
- */
-
-import { Server } from "@modelcontextprotocol/sdk/server/index.js";
-import { StreamableHTTPServerTransport } from "@modelcontextprotocol/sdk/server/streamableHttp.js";
-import { CallToolRequestSchema, ListToolsRequestSchema } from "@modelcontextprotocol/sdk/types.js";
-import * as http from "http";
-
-const server = new Server(
-  {
-    name: "test-http-server",
-    version: "1.0.0",
-  },
-  {
-    capabilities: {
-      tools: {},
-    },
-  }
-);
-
-// Define tools
-server.setRequestHandler(ListToolsRequestSchema, async () => {
-  return {
-    tools: [
-      {
-        name: "echo",
-        description: "Echoes back the input",
-        inputSchema: {
-          type: "object" as const,
-          properties: {
-            message: { type: "string", description: "Message to echo" },
-          },
-          required: ["message"],
-        },
-      },
-    ],
-  };
-});
-
-server.setRequestHandler(CallToolRequestSchema, async (request) => {
-  const { name, arguments: args } = request.params;
-
-  if (name === "echo") {
-    return {
-      content: [{ type: "text", text: (args as { message: string }).message }],
-    };
-  }
-
-  throw new Error(`Unknown tool: ${name}`);
-});
-
-// Create HTTP server with streamable transport
-async function main() {
-  const httpServer = http.createServer();
-  const transport = new StreamableHTTPServerTransport({ sessionIdGenerator: undefined });
-
-  httpServer.on("request", async (req, res) => {
-    // Simple CORS support
-    res.setHeader("Access-Control-Allow-Origin", "*");
-    res.setHeader("Access-Control-Allow-Methods", "GET, POST, OPTIONS");
-    res.setHeader("Access-Control-Allow-Headers", "Content-Type");
-
-    if (req.method === "OPTIONS") {
-      res.writeHead(200);
-      res.end();
-      return;
-    }
-
-    if (req.url === "/mcp" || req.url?.startsWith("/mcp?")) {
-      await transport.handleRequest(req, res);
-    } else {
-      res.writeHead(404);
-      res.end("Not found");
-    }
-  });
-
-  await server.connect(transport);
-
-  // Use port 0 to let the OS assign a free port, unless specific port given
-  const requestedPort = parseInt(process.argv[2] || "0", 10);
-  httpServer.listen(requestedPort, () => {
-    const addr = httpServer.address();
-    const actualPort = typeof addr === "object" && addr ? addr.port : requestedPort;
-    // Output format that tests parse: "listening on port XXXXX"
-    console.log(`Test HTTP MCP server listening on port ${actualPort}`);
-  });
-
-  // Handle shutdown
-  process.on("SIGTERM", () => {
-    httpServer.close();
-    process.exit(0);
-  });
-  process.on("SIGINT", () => {
-    httpServer.close();
-    process.exit(0);
-  });
-}
-
-main().catch(console.error);