Skip to content

Rethunk-AI/rethunk-mcp-ts

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

63 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Rethunk MCP for TypeScript

A production-grade Model Context Protocol (MCP) server by Rethunk.Tech featuring TypeScript code inspection, atomic git commits with intelligent message validation, and robust support for building scalable MCP applications.

2 Tools • 0 Resources • 1 Prompt

Version MCP Spec MCP SDK License Status TypeScript Bun Tests Code Coverage


✨ Features

  • Declarative Tools & Resources: Define capabilities in single, self-contained files. The framework handles registration and execution.
  • Elicitation Support: Tools can interactively prompt the user for missing parameters during execution, streamlining user workflows.
  • Robust Error Handling: A unified McpError system ensures consistent, structured error responses across the server.
  • Pluggable Authentication: Secure your server with zero-fuss support for none, jwt, or oauth modes.
  • Abstracted Storage: Swap storage backends (in-memory, filesystem, Supabase, SurrealDB, Cloudflare D1/KV/R2) without changing business logic. Features secure opaque cursor pagination, parallel batch operations, and comprehensive validation.
  • Graph Database Operations: Optional graph service for relationship management, graph traversals, and pathfinding algorithms (SurrealDB provider).
  • Full-Stack Observability: Get deep insights with structured logging (Pino) and optional, auto-instrumented OpenTelemetry for traces and metrics.
  • Dependency Injection: Built with tsyringe for a clean, decoupled, and testable architecture.
  • Service Integrations: Pluggable services for external APIs, including LLM providers (OpenRouter), text-to-speech (ElevenLabs), and graph operations (SurrealDB).
  • Rich Built-in Utility Suite: Helpers for parsing (PDF, YAML, CSV, frontmatter), formatting (diffs, tables, trees, markdown), scheduling, security, and more.
  • Edge-Ready: Write code once and run it seamlessly on your local machine or at the edge on Cloudflare Workers.

🏗️ Architecture

This template follows a modular, domain-driven architecture with clear separation of concerns:

┌─────────────────────────────────────────────────────────┐
│              MCP Client (Claude Code, ChatGPT, etc.)    │
└────────────────────┬────────────────────────────────────┘
                     │ JSON-RPC 2.0
                     ▼
┌─────────────────────────────────────────────────────────┐
│           MCP Server (Tools, Resources)                 │
│           📖 [MCP Server Guide](src/mcp-server/)        │
└────────────────────┬────────────────────────────────────┘
                     │ Dependency Injection
                     ▼
┌─────────────────────────────────────────────────────────┐
│          Dependency Injection Container                 │
│              📦 [Container Guide](src/container/)       │
└────────────────────┬────────────────────────────────────┘
                     │
        ┌────────────┼────────────┐
        ▼            ▼            ▼
 ┌──────────┐   ┌──────────┐   ┌──────────┐
 │ Services │   │ Storage  │   │ Utilities│
 │ 🔌 [→]   │   │ 💾 [→]   │   │ 🛠️ [→]   │
 └──────────┘   └──────────┘   └──────────┘

[→]: src/services/    [→]: src/storage/    [→]: src/utils/

Key Modules:

  • MCP Server - Tools, resources, prompts, and transport layer implementations
  • Container - Dependency injection setup with tsyringe for clean architecture
  • Services - External service integrations (LLM, Speech, Graph) with pluggable providers
  • Storage - Abstracted persistence layer with multiple backend support
  • Utilities - Cross-cutting concerns (logging, security, parsing, telemetry)

💡 Tip: Each module has its own comprehensive README with architecture diagrams, usage examples, and best practices. Click the links above to dive deeper!

🛠️ Included Capabilities

This server exposes a single, production-ready tool for atomic git operations.

Tools

Tool Description
check_typescript_project_for_problems Runs quick local quality checks including lint fixing and type checking. Returns combined output in machine-parseable JSON format.
stage_selected_specs_and_create_atomic_commit Stages specified files or line ranges and creates one atomic commit with GPT-5 Nano-validated conventional messages. Uses Vercel AI SDK to enforce why-focused commit reasoning. No push—only stage and commit.

🚀 Getting Started

Prerequisites

  • Bun v1.2.21 or higher.
  • An OpenAI API key (required for the commit message validation feature). Get one here.

Installation & Configuration by IDE

Choose your IDE and follow the corresponding setup steps.

VSCode + Cline Extension

  1. Install the Cline extension in VSCode.
  2. Open your VSCode settings and locate the Cline configuration file (usually at ~/.config/Code/User/globalStorage/saoudrizwan.claude-dev/cline_mcp_settings.json).

Option A: Using Published Registry (easiest)

  1. Add the following MCP server configuration:
{
  "mcpServers": {
    "rethunk-mcp-typescript": {
      "type": "stdio",
      "command": "bunx",
      "args": ["rethunk-mcp-typescript@latest"],
      "env": {
        "MCP_TRANSPORT_TYPE": "stdio",
        "MCP_LOG_LEVEL": "info",
        "OPENAI_API_KEY": "sk-..."
      }
    }
  }
}

Option B: Using Local Clone (for development)

  1. First, clone the repository and build it:
git clone https://github.com/Rethunk-Tech/rethunk-mcp-ts.git /path/to/local/rethunk-mcp-ts
cd /path/to/local/rethunk-mcp-ts
bun install
bun rebuild
  1. Then add this configuration, replacing /path/to/local/rethunk-mcp-ts with your actual path:
{
  "mcpServers": {
    "rethunk-mcp-typescript": {
      "type": "stdio",
      "command": "bun",
      "args": ["--cwd", "/path/to/local/rethunk-mcp-ts", "start:stdio"],
      "env": {
        "MCP_TRANSPORT_TYPE": "stdio",
        "MCP_LOG_LEVEL": "info",
        "OPENAI_API_KEY": "sk-..."
      }
    }
  }
}

Cursor IDE + MCP Integration

  1. Open Cursor and navigate to Settings → MCP.

Option A: Using Published Registry (easiest)

  1. Click Add Server and add the following configuration:
{
  "name": "rethunk-mcp-typescript",
  "type": "stdio",
  "command": "bunx",
  "args": ["rethunk-mcp-typescript@latest"],
  "env": {
    "MCP_TRANSPORT_TYPE": "stdio",
    "MCP_LOG_LEVEL": "info",
    "OPENAI_API_KEY": "sk-..."
  }
}

Option B: Using Local Clone (for development)

  1. First, clone the repository and build it:
git clone https://github.com/Rethunk-Tech/rethunk-mcp-ts.git /path/to/local/rethunk-mcp-ts
cd /path/to/local/rethunk-mcp-ts
bun install
bun rebuild
  1. Then click Add Server and add this configuration, replacing /path/to/local/rethunk-mcp-ts with your actual path:
{
  "name": "rethunk-mcp-typescript",
  "type": "stdio",
  "command": "bun",
  "args": ["--cwd", "/path/to/local/rethunk-mcp-ts", "start:stdio"],
  "env": {
    "MCP_TRANSPORT_TYPE": "stdio",
    "MCP_LOG_LEVEL": "info",
    "OPENAI_API_KEY": "sk-..."
  }
}
  1. Save and restart Cursor to enable the tool.

Claude Desktop

  1. Locate your Claude Desktop configuration file:
    • macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
    • Windows: %APPDATA%\Claude\claude_desktop_config.json
    • Linux: ~/.config/Claude/claude_desktop_config.json

Option A: Using Published Registry (easiest)

  1. Add the following MCP server configuration:
{
  "mcpServers": {
    "rethunk-mcp-typescript": {
      "command": "bunx",
      "args": ["rethunk-mcp-typescript@latest"],
      "env": {
        "MCP_TRANSPORT_TYPE": "stdio",
        "MCP_LOG_LEVEL": "info",
        "OPENAI_API_KEY": "sk-..."
      }
    }
  }
}

Option B: Using Local Clone (for development)

  1. First, clone the repository and build it:
git clone https://github.com/Rethunk-Tech/rethunk-mcp-ts.git /path/to/local/rethunk-mcp-ts
cd /path/to/local/rethunk-mcp-ts
bun install
bun rebuild
  1. Then add this configuration, replacing /path/to/local/rethunk-mcp-ts with your actual path:
{
  "mcpServers": {
    "rethunk-mcp-typescript": {
      "command": "bun",
      "args": ["--cwd", "/path/to/local/rethunk-mcp-ts", "start:stdio"],
      "env": {
        "MCP_TRANSPORT_TYPE": "stdio",
        "MCP_LOG_LEVEL": "info",
        "OPENAI_API_KEY": "sk-..."
      }
    }
  }
}
  1. Restart Claude Desktop to activate the integration.

Local Development (Direct Execution)

For development or testing without an IDE integration:

# Clone the repository
git clone https://github.com/Rethunk-Tech/rethunk-mcp-ts.git
cd rethunk-mcp-ts

# Install dependencies
bun install

# Build the server
bun rebuild

# Set environment variables
export MCP_TRANSPORT_TYPE=stdio
export MCP_LOG_LEVEL=info
export OPENAI_API_KEY="sk-your-key-here"

# Run the server
bun start:stdio

Environment Configuration Reference

All MCP server instances require these key variables:

Variable Description Required Example
OPENAI_API_KEY OpenAI API key for commit message validation (GPT-5 Nano). ✅ Yes sk-proj-...
MCP_TRANSPORT_TYPE Transport protocol for MCP communication. No stdio (default)
MCP_LOG_LEVEL Logging verbosity (debug, info, warn, error). No info

Important: Never commit your .env file or API keys to version control. Use environment variables or secure secret management tools instead.

Installation (Local Development)

  1. Clone the repository:
git clone https://github.com/Rethunk-Tech/rethunk-mcp-ts.git
  1. Navigate into the directory:
cd rethunk-mcp-ts
  1. Install dependencies:
bun install
  1. Build the server:
bun rebuild
  1. Create a .env file and add your OpenAI key:
cp .env.example .env  # If available, or create a new file
echo "OPENAI_API_KEY=sk-your-key-here" >> .env

⚙️ Configuration

All configuration is centralized and validated at startup in src/config/index.ts. Key environment variables include:

Core Configuration

Variable Description Default Required
OPENAI_API_KEY OpenAI API key for commit message validation (GPT-5 Nano). Get from here. (none) ✅ Yes
MCP_TRANSPORT_TYPE The transport to use: stdio or http. http No
MCP_HTTP_PORT The port for the HTTP server. 3010 No
MCP_HTTP_HOST The hostname for the HTTP server. 127.0.0.1 No
MCP_AUTH_MODE Authentication mode: none, jwt, or oauth. none No
MCP_AUTH_SECRET_KEY Required for jwt auth mode. A 32+ character secret. (none) No
OAUTH_ISSUER_URL Required for oauth auth mode. URL of the OIDC provider. (none) No
STORAGE_PROVIDER_TYPE Storage backend: in-memory, filesystem, supabase, surrealdb, cloudflare-d1, cloudflare-kv, cloudflare-r2. in-memory No
STORAGE_FILESYSTEM_PATH Required for filesystem storage. Path to the storage directory. (none) No
SUPABASE_URL Required for supabase storage. Your Supabase project URL. (none) No
SUPABASE_SERVICE_ROLE_KEY Required for supabase storage. Your Supabase service role key. (none) No
SURREALDB_URL Required for surrealdb storage. SurrealDB endpoint (e.g., wss://cloud.surrealdb.com/rpc). (none) No
SURREALDB_NAMESPACE Required for surrealdb storage. SurrealDB namespace. (none) No
SURREALDB_DATABASE Required for surrealdb storage. SurrealDB database name. (none) No
SURREALDB_USERNAME Optional for surrealdb storage. Database username for authentication. (none) No
SURREALDB_PASSWORD Optional for surrealdb storage. Database password for authentication. (none) No
OTEL_ENABLED Set to true to enable OpenTelemetry. false No
LOG_LEVEL The minimum level for logging (debug, info, warn, error). info No
OPENROUTER_API_KEY API key for OpenRouter LLM service. (none) No

Authentication & Authorization

  • Modes: none (default), jwt (requires MCP_AUTH_SECRET_KEY), or oauth (requires OAUTH_ISSUER_URL and OAUTH_AUDIENCE).
  • Enforcement: Wrap your tool/resource logic functions with withToolAuth([...]) or withResourceAuth([...]) to enforce scope checks. Scope checks are bypassed for developer convenience when auth mode is none.

Storage

  • Service: A DI-managed StorageService provides a consistent API for persistence. Never access fs or other storage SDKs directly from tool logic.
  • Providers: The default is in-memory. Node-only providers include filesystem. Edge-compatible providers include supabase, surrealdb, cloudflare-kv, and cloudflare-r2.
  • SurrealDB Setup: When using surrealdb provider, initialize the database schema using docs/surrealdb-schema.surql before first use.
  • Multi-Tenancy: The StorageService requires context.tenantId. This is automatically propagated from the tid claim in a JWT when auth is enabled.
  • Advanced Features:
    • Secure Pagination: Opaque cursors with tenant ID binding prevent cross-tenant attacks
    • Batch Operations: Parallel execution for getMany(), setMany(), deleteMany()
    • TTL Support: Time-to-live with proper expiration handling across all providers
    • Comprehensive Validation: Centralized input validation for tenant IDs, keys, and options

Observability

  • Structured Logging: Pino is integrated out-of-the-box. All logs are JSON and include the RequestContext.
  • OpenTelemetry: Disabled by default. Enable with OTEL_ENABLED=true and configure OTLP endpoints. Traces, metrics (duration, payload sizes), and errors are automatically captured for every tool call.

▶️ Running the Server

Local Development

  • Build and run the production version:

    # One-time build
    bun rebuild
    
    # Run the built server
    bun start:http
    # or
    bun start:stdio
  • Run checks and tests:

    bun devcheck # Lints, formats, type-checks, and more
    bun run test # Runs the test suite (Do not use 'bun test' directly as it may not work correctly)

Cloudflare Workers

  1. Build the Worker bundle:
bun build:worker
  1. Run locally with Wrangler:
bun deploy:dev
  1. Deploy to Cloudflare:
bun deploy:prod

Note: The wrangler.toml file is pre-configured to enable nodejs_compat for best results.

📂 Project Structure

Directory Purpose & Contents Guide
src/mcp-server/tools/definitions Your tool definitions (*.tool.ts). This is where you add new capabilities. 📖 MCP Guide
src/mcp-server/resources/definitions Your resource definitions (*.resource.ts). This is where you add new data sources. 📖 MCP Guide
src/mcp-server/transports Implementations for HTTP and STDIO transports, including auth middleware. 📖 MCP Guide
src/storage The StorageService abstraction and all storage provider implementations. 💾 Storage Guide
src/services Integrations with external services (e.g., the default OpenRouter LLM provider). 🔌 Services Guide
src/container Dependency injection container registrations and tokens. 📦 Container Guide
src/utils Core utilities for logging, error handling, performance, security, and telemetry.
src/config Environment variable parsing and validation with Zod.
tests/ Unit and integration tests, mirroring the src/ directory structure.

📚 Documentation

Each major module includes comprehensive documentation with architecture diagrams, usage examples, and best practices:

Core Modules

  • MCP Server Guide - Complete guide to building MCP tools and resources

    • Creating tools with declarative definitions
    • Resource development with URI templates
    • Authentication and authorization
    • Transport layer (HTTP/stdio) configuration
    • SDK context and client interaction
    • Response formatting and error handling
  • Container Guide - Dependency injection with tsyringe

    • Understanding DI tokens and registration
    • Service lifetimes (singleton, transient, instance)
    • Constructor injection patterns
    • Testing with mocked dependencies
    • Adding new services to the container
  • Services Guide - External service integration patterns

    • LLM provider integration (OpenRouter)
    • Speech services (TTS/STT with ElevenLabs, Whisper)
    • Graph database operations (SurrealDB)
    • Creating custom service providers
    • Health checks and error handling
  • Storage Guide - Abstracted persistence layer

    • Storage provider implementations
    • Multi-tenancy and tenant isolation
    • Secure cursor-based pagination
    • Batch operations and TTL support
    • Provider-specific setup guides

Additional Resources

🧑‍💻 Agent Development Guide

For a strict set of rules when using this template with an AI agent, please refer to AGENTS.md. Key principles include:

  • Logic Throws, Handlers Catch: Never use try/catch in your tool/resource logic. Throw an McpError instead.
  • Use Elicitation for Missing Input: If a tool requires user input that wasn't provided, use the elicitInput function from the SdkContext to ask the user for it.
  • Pass the Context: Always pass the RequestContext object through your call stack.
  • Use the Barrel Exports: Register new tools and resources only in the index.ts barrel files.

❓ FAQ

  • Does this work with both STDIO and Streamable HTTP?
    • Yes. Both transports are first-class citizens. Use bun run dev:stdio or bun run dev:http.
  • Can I deploy this to the edge?
    • Yes. The template is designed for Cloudflare Workers. Run bun run build:worker and deploy with Wrangler.
  • Do I have to use OpenTelemetry?
    • No, it is disabled by default. Enable it by setting OTEL_ENABLED=true in your .env file.
  • How do I publish my server to the MCP Registry?
    • Follow the step-by-step guide in docs/publishing-mcp-server-registry.md.

🤝 Contributing

Issues and pull requests are welcome! If you plan to contribute, please run the local checks and tests before submitting your PR.

bun run devcheck
bun test

📜 License

This project is licensed under the Apache 2.0 License. See the LICENSE file for details.


About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Sponsor this project

  •  

Packages

 
 
 

Contributors

Generated from cyanheads/mcp-ts-core