- Home
- MCP servers
- Synergy/DE
Synergy/DE
- typescript
0
GitHub Stars
typescript
Language
5 months ago
First Indexed
2 months ago
Catalog Refreshed
Documentation & install
Readme and setup notes from the catalogue, plus a client-ready config you can copy for your MCP host.
Installation
Add the following to your MCP client configuration file.
Configuration
View docs{
"mcpServers": {
"h0ck3ystyx-synergyde-mcp": {
"command": "node",
"args": [
"/absolute/path/to/synergyde-mcp/dist/server.js"
],
"env": {
"LOG_LEVEL": "info",
"SYNERGYDE_CACHE_DIR": "/path/to/cache",
"SYNERGYDE_DOC_BASE_URL": "https://www.synergex.com/docs/",
"SYNERGYDE_LOCAL_DOC_PATH": "/path/to/local/docs",
"SYNERGYDE_DOC_DEFAULT_VERSION": "latest"
}
}
}
}You can run and connect to a read-only MCP server that exposes Synergy/DE documentation as searchable topics and browseable resources. This server is designed to work with MCP clients to search, fetch topic content in chunks optimized for language models, and navigate related topics and sections without writing to remote sources. You configure it once and then use your MCP client to query topics, sections, and relationships to build rich documentation experiences.
How to use
Start the MCP server using an MCP-enabled client. The server is designed to run as a stdio-based service that your MCP client can connect to, so you do not interact with it as a background web service. You will load the server via a local command, perform MCP requests to search topics, fetch topic content in chunks, and navigate related topics and sections. You can run it with or without local documentation, depending on your setup, and you can adjust the default documentation version that the server uses for requests.
How to install
Prerequisites you need before installing the server:
- Node.js 18.0.0 or higher to run the server and access the built-in fetch API
How to install
Step by step commands to install and prepare the MCP server for use.
# Clone the MCP server repository
git clone https://github.com/h0ck3ystyx/synergyde-mcp.git
cd synergyde-mcp
# Install dependencies
npm install
# or
pnpm install
# Build the project
npm run build
# Optionally configure environment variables
cp .env.example .env
# Edit .env with your preferences
Configure and run (stdio MCP)
To run the MCP server as a local stdio process that an MCP client can connect to, use the following runtime configuration. The command launches the server bundled in your build output.
{
"type": "stdio",
"name": "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"
}
}
Usage with a Cursor MCP configuration
In Cursor, add a server entry that points to your locally built MCP server. Use absolute paths and the stdio running command shown below.
{
"mcpServers": {
"synergyde-docs": {
"command": "node",
"args": ["/absolute/path/to/synergyde-mcp/dist/server.js"],
"env": {
"SYNERGYDE_DOC_DEFAULT_VERSION": "latest"
}
}
}
}
Configuration details
You can customize how the server fetches documentation by setting environment variables. These control the base URL, default version, local documentation support, and caching behavior.
Troubleshooting
If the server won’t start or you encounter errors, verify your Node.js version is 18+ and that dependencies are installed. Check that the build completed successfully, and review logs for specific error messages. For Cursor integration, ensure the MCP configuration file is valid JSON and that absolute paths are used for the server executable.
Development notes
The project supports offline, online, or hybrid documentation sources with a caching layer to reduce network requests. You will recognize its modular structure and TypeScript code with strict typing across providers, parser, cache, search, and MCP server components.
Available tools
search_docs
Search documentation topics using full-text search with optional version, section filter, and limit; returns results with relevance scores.
get_topic
Fetch a documentation topic by ID or URL, returning a topic object with chunked content.
get_related_topics
Retrieve related topics for a given topic, including previous, next, parent, and related links.
list_section_topics
List topics within a specified section, with optional version and limit.
describe_docs
Provide metadata about available documentation, including versions and sections.