JDSS REST Documentation

Provides access to Open-E JovianDSS REST API documentation with search, analysis, and ZIP download capabilities.

javascript

0

GitHub Stars

javascript

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": {
    "miroslawfranek-jdss-rest-documentation-mcp": {
      "command": "jdss-rest-doc-mcp",
      "args": [
        "start"
      ],
      "env": {
        "NODE_ENV": "production"
      }
    }
  }
}

You run an MCP server that gives Claude Code access to Open-E JovianDSS REST API documentation, enabling intelligent help with JovianDSS development and integration. This server makes it easy to fetch latest or trunk docs, search terms, analyze endpoints, download ZIP packages, and compare versions, all from a single local or remote MCP endpoint.

How to use

Set up your MCP client to connect to the jdss-rest-documentation server, then use its capabilities to access and analyze JovianDSS REST API documentation. Start by launching the MCP server and ensuring it has access to the documentation sources listed in your environment. Use the available tools to get documentation content, search for terms like volume or authentication, analyze API endpoints and schemas, download complete documentation as ZIP for offline use, and compare latest versus trunk versions to review changes.

How to install

Prerequisites you need before installation: Node.js version 18.0.0 or higher and npm. Ensure your machine has network access to reach the JovianDSS documentation sources.

# Quick Install (Recommended)
# Install globally from GitHub
npm install -g https://github.com/miroslawfranek/JDSS-REST-Documentation-MCP.git

# Verify installation
jdss-rest-doc --help

Manual installation steps you can follow if you clone the project locally and want to run from source.

# Clone repository
git clone https://github.com/miroslawfranek/JDSS-REST-Documentation-MCP.git
cd JDSS-REST-Documentation-MCP

# Install dependencies
npm install

# Make globally available
npm install -g .

Using an installation script to perform the setup in one go.

# Run the comprehensive installation script
./install.sh

Configuration and usage notes

Configure the MCP server in your client to ensure smooth operation. You can customize how you run the server, including environment variables, and you can choose to expose the server via a local stdio interface or via an HTTP URL if needed.

Security and environment

Set environment variables as required by your deployment. For production usage, you typically want NODE_ENV set to production to optimize performance and disable debugging features.

Troubleshooting tips

If the server fails to start, verify Node.js and npm are installed, confirm network access to JovianDSS documentation sources, and check that the MCP command is available in your PATH. Ensure any required environment variables are provided.

Examples of typical tasks

Start the MCP server and begin exploring documentation, or test connectivity to ensure you can retrieve the latest or trunk documentation, run searches, and download ZIP packages for offline use.

Available tools

get_edss_documentation

Retrieve JDSS REST API documentation content. Parameters include version (latest or trunk) and optional section to extract.

search_edss_documentation

Search within the documentation for specific terms. Parameters include query and version (latest, trunk, or both).

analyze_edss_api_endpoints

Extract and analyze API endpoints from documentation, with an option for detailed analysis.

download_edss_documentation

Provide information about downloading the documentation as a ZIP file.

compare_documentation_versions

Compare different versions of the documentation, focusing on endpoints, changes, or summaries.