Skip to content

overview.md

Latest commit

 

History

History
35 lines (30 loc) · 1.78 KB

overview.md

File metadata and controls

35 lines (30 loc) · 1.78 KB

Project Roadmap

Phase 1: Foundation & Core Tools

Goal: Get a basic MCP server running that exposes the bake capability.

  • Install MCP SDK dependencies.
  • Create src/node/mcp-server.mjs.
  • Implement cyberchef_bake tool (generic input/recipe execution).
  • Implement cyberchef_search tool (wrapping help() function).
  • Verify basic connectivity via stdio.

Phase 2: Dynamic Tool Mapping

Goal: Expose specific CyberChef operations as individual tools.

  • Implement argument type mapping (CyberChef Args -> Zod Schema).
  • Dynamic registration loop in listTools handler.
  • Dynamic dispatch logic in callTool handler.
  • Handle edge cases (Option mapping, Defaults).

Phase 3: Dockerization

Goal: specific container image for the MCP server.

  • Create Dockerfile.mcp.
  • Build and test the container locally (Tested code, Dockerfile created).

Phase 4: Polish & Documentation

Goal: Ensure usability and stability.

  • Add comprehensive descriptions to tools (Used descriptions from Config).
  • Create README_MCP.md with usage instructions.
  • Clean up code and add comments.
  • Add mcp script to package.json.

Phase 5: Deployment & Automation

Goal: Automate distribution and ensure long-term reliability.

  • CI/CD Pipeline: Create GitHub Actions to automatically build the cyberchef-mcp Docker image on commit.
  • Publishing: Push the container image to GitHub Container Registry (GHCR) or Docker Hub so users don't have to build it locally.
  • Automated Testing: Create a proper integration test suite using an MCP client mock to verify the server without manual echo | docker commands.
  • Upstream Sync: Establish a workflow to merge changes from the original gchq/CyberChef repository.