Synergy/DE MCP Server

Synergy/DE MCP Server

A read-only Model Context Protocol (MCP) server that exposes Synergy/DE documentation as tools and resources, making it easy to search, retrieve, and browse documentation topics from Cursor and other MCP clients.

Features

• Full-text search across Synergy/DE documentation with relevance scoring
• Topic retrieval with chunked content optimized for LLM consumption
• Related topics navigation (previous, next, parent, and related links)
• Section browsing to discover topics by category
• Version support for different Synergy/DE documentation versions
• Intelligent caching to minimize network requests and improve performance
• Online and local documentation support (hybrid mode available)
• MCP Resources for direct topic and section access in Cursor

Prerequisites

• Node.js 18.0.0 or higher (provides built-in fetch API for HTTP requests)
• npm or pnpm package manager
• Cursor (for MCP integration) or another MCP-compatible client

Installation

1. Clone this repository:

   git clone https://github.com/h0ck3ystyx/synergyde-mcp.git
   cd synergyde-mcp
   

2. Install dependencies:

   npm install
   # or
   pnpm install
   

3. Build the project:

   npm run build
   

4. Configure environment variables (optional):

   cp .env.example .env
   # Edit .env with your preferences
   

Configuration

The server can be configured via environment variables. All variables are optional and have sensible defaults.

Environment Variables

Configuration Details

• SYNERGYDE_DOC_BASE_URL: The base URL for the Synergy/DE documentation site. Should end with a trailing slash (automatically added if missing).

• SYNERGYDE_DOC_DEFAULT_VERSION: The default version to use when no version is specified in tool calls. Common values: "latest", "v111", "v112", etc.

• SYNERGYDE_LOCAL_DOC_PATH: If provided, enables local documentation support. The path must be readable and point to a directory containing local documentation files. When set, the server operates in "hybrid" mode, preferring local docs but falling back to online docs if a topic isn't found locally.

• SYNERGYDE_CACHE_DIR: Directory where parsed topics are cached on disk. The directory will be created automatically if it doesn't exist. Cached topics are stored as JSON files keyed by version and topic ID.

• LOG_LEVEL: Controls the verbosity of logging. Use debug for detailed information during development, info for normal operation, warn for warnings only, or error for errors only.

Example `.env` File

# Use online documentation with latest version
SYNERGYDE_DOC_BASE_URL=https://www.synergex.com/docs/
SYNERGYDE_DOC_DEFAULT_VERSION=latest

# Cache directory (relative to project root)
SYNERGYDE_CACHE_DIR=./cache

# Logging level
LOG_LEVEL=info

Usage

Running the Server

The server uses stdio transport and is designed to be launched by MCP clients:

npm start

The server will:

• Initialize configuration
• Connect to stdio transport
• Wait for MCP requests from clients

Note: The server is intended to be run by MCP clients (like Cursor), not directly. Running it manually will cause it to wait for input on stdin.

Cursor MCP Configuration

Add the server to your Cursor MCP configuration. The configuration file location depends on your setup:

• Global config: ~/.cursor/mcp.json (macOS/Linux) or %APPDATA%\Cursor\mcp.json (Windows)
• Project config: .cursor/mcp.json in your project root

Basic Configuration

{
  "mcpServers": {
    "synergyde-docs": {
      "command": "node",
      "args": ["/absolute/path/to/synergyde-mcp/dist/server.js"],
      "env": {
        "SYNERGYDE_DOC_DEFAULT_VERSION": "latest"
      }
    }
  }
}

Advanced Configuration with Local Docs

{
  "mcpServers": {
    "synergyde-docs": {
      "command": "node",
      "args": ["/absolute/path/to/synergyde-mcp/dist/server.js"],
      "env": {
        "SYNERGYDE_DOC_BASE_URL": "https://www.synergex.com/docs/",
        "SYNERGYDE_DOC_DEFAULT_VERSION": "latest",
        "SYNERGYDE_LOCAL_DOC_PATH": "/path/to/local/docs",
        "SYNERGYDE_CACHE_DIR": "/path/to/cache",
        "LOG_LEVEL": "info"
      }
    }
  }
}

Important: Use absolute paths for the server executable and any fil