Skip to main content
Glama
miroslawfranek

Open-E JovianDSS REST API Documentation MCP Server

get_edss_documentation_enhanced

Retrieve Open-E JovianDSS REST API documentation with automatic version detection and jQuery processing to reveal hidden content.

Instructions

Get EDSS documentation with automatic version discovery and jQuery processing

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
versionNoVersion: 'latest', 'trunk', or specific release namelatest
apiVersionNov4
useJavaScriptNoProcess with jQuery to reveal hidden content

Implementation Reference

  • Main handler function for the 'get_edss_documentation_enhanced' tool. Retrieves EDSS documentation with automatic version discovery and optional jQuery processing to reveal hidden content.
    async getDocumentationEnhanced(args) {
      const version = args?.version || 'latest';
      const apiVersion = args?.apiVersion || 'v4';
      const useJavaScript = args?.useJavaScript !== false; // default true
    
      try {
        // Get available links
        const links = await this.discoverDocumentationLinks();
        
        // Find the appropriate link
        let targetLink = null;
        const lookupKey = `${version.toLowerCase()}_${apiVersion}`;
        
        if (links[lookupKey]) {
          targetLink = links[lookupKey];
        } else if (version === 'latest') {
          // Try to find any latest version
          targetLink = links[`latest_${apiVersion}`] || links[Object.keys(links).find(k => k.includes('latest'))];
        } else if (version === 'trunk') {
          targetLink = links[`trunk_${apiVersion}`] || links[Object.keys(links).find(k => k.includes('trunk'))];
        }
        
        if (!targetLink) {
          throw new Error(`Could not find documentation for version: ${version}, apiVersion: ${apiVersion}`);
        }
    
        // Download ZIP file
        const response = await fetch(targetLink.zipUrl);
        if (!response.ok) {
          throw new Error(`Failed to download documentation: ${response.status}`);
        }
    
        const zipBuffer = await response.arrayBuffer();
        
        if (useJavaScript) {
          // Process with jQuery to reveal hidden content
          const processedHTML = await this.processZipWithJQuery(zipBuffer);
          
          return {
            content: [
              {
                type: "text", 
                text: `Enhanced EDSS Documentation (${targetLink.release} ${apiVersion})\n` +
                     `Source: ${targetLink.zipUrl}\n` +
                     `Processed with jQuery: ${useJavaScript ? 'YES' : 'NO'}\n\n` +
                     processedHTML
              }
            ]
          };
        } else {
          // Standard ZIP extraction
          const zip = new JSZip();
          const contents = await zip.loadAsync(zipBuffer);
          
          let htmlContent = '';
          for (const [path, file] of Object.entries(contents.files)) {
            if (path.endsWith('.html') && !file.dir) {
              htmlContent = await file.async('text');
              break;
            }
          }
          
          return {
            content: [
              {
                type: "text",
                text: `EDSS Documentation (${targetLink.release} ${apiVersion})\n` +
                     `Source: ${targetLink.zipUrl}\n\n` +
                     htmlContent
              }
            ]
          };
        }
      } catch (error) {
        return {
          content: [
            {
              type: "text",
              text: `Error retrieving enhanced documentation: ${error.message}`
            }
          ]
        };
      }
    }
  • Tool registration schema with input validation. Defines parameters: version (string, default 'latest'), apiVersion (enum v3/v4, default v4), and useJavaScript (boolean, default true).
      name: "get_edss_documentation_enhanced",
      description: "Get EDSS documentation with automatic version discovery and jQuery processing",
      inputSchema: {
        type: "object",
        properties: {
          version: {
            type: "string",
            default: "latest",
            description: "Version: 'latest', 'trunk', or specific release name"
          },
          apiVersion: {
            type: "string",
            enum: ["v3", "v4"],
            default: "v4"
          },
          useJavaScript: {
            type: "boolean",
            default: true,
            description: "Process with jQuery to reveal hidden content"
          }
        }
      }
    }
  • index.js:201-202 (registration)
    Registration of the tool in the call handler switch statement, routing to this.getDocumentationEnhanced(args).
    case "get_edss_documentation_enhanced":
      return await this.getDocumentationEnhanced(args);
  • Helper function processZipWithJQuery: extracts HTML and jQuery from a ZIP file, creates a virtual DOM with JSDOM, injects jQuery, and returns the processed HTML.
    async processZipWithJQuery(zipBuffer) {
      try {
        const zip = new JSZip();
        const contents = await zip.loadAsync(zipBuffer);
        
        // Find HTML and jQuery files
        let mainHTML = '';
        let jqueryCode = '';
        
        for (const [path, file] of Object.entries(contents.files)) {
          if (path.endsWith('.html') && !file.dir && !mainHTML) {
            mainHTML = await file.async('text');
          }
          if (path.includes('jquery') && path.endsWith('.js')) {
            jqueryCode = await file.async('text');
          }
        }
        
        if (!mainHTML) {
          throw new Error('No HTML file found in ZIP');
        }
        
        if (!jqueryCode) {
          console.warn('No jQuery found in ZIP, returning unprocessed HTML');
          return mainHTML;
        }
        
        // Create virtual DOM
        const dom = new JSDOM(mainHTML, {
          runScripts: "dangerously",
          resources: "usable"
        });
        
        const window = dom.window;
        const document = window.document;
        
        // Inject jQuery
        const scriptElement = document.createElement('script');
        scriptElement.textContent = jqueryCode;
        document.head.appendChild(scriptElement);
        
        // Wait for jQuery to load and then reveal content
        await new Promise(resolve => {
          setTimeout(async () => {
            try {
              await this.revealAllContent(window);
            } catch (error) {
              console.warn('jQuery processing error:', error.message);
            }
            resolve();
          }, 1000);
        });
        
        return document.documentElement.outerHTML;
        
      } catch (error) {
        throw new Error(`jQuery processing failed: ${error.message}`);
      }
    }
  • Helper function revealAllContent: uses jQuery to simulate clicks on toggle buttons and reveal hidden elements in the documentation.
    async revealAllContent(window) {
      const $ = window.$;
      if (!$) {
        throw new Error('jQuery not available');
      }
      
      // Simulate clicks on all toggle buttons
      $('.toggleOperation').each(function() {
        try {
          $(this).trigger('click');
        } catch (e) {
          // Ignore individual click errors
        }
      });
      
      // Force show hidden elements
      $('div[style*="display: none"]').show();
      $('.content.func_doc').show();
      $('.content.func_src').show(); 
      $('.operation').show();
      $('.endpoint').show();
      
      // Remove any remaining display: none styles
      $('[style*="display: none"]').css('display', '');
    }
Behavior2/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

No annotations exist, so the description must disclose behaviors. It mentions jQuery processing to reveal hidden content, implying a non-destructive transformation, but fails to clarify side effects, auth needs, or error handling, leaving significant gaps.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is a single, concise sentence. While it is efficiently brief, it could include a bit more detail without becoming verbose, such as the purpose of the tool relative to siblings.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

The description lacks critical context: no mention of return format, error conditions, or what 'automatic version discovery' entails. Given no output schema and 3 parameters, the description should provide more to ensure the agent can use the tool correctly.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 67% (descriptions for 'version' and 'useJavaScript'), and the description adds context by linking 'automatic version discovery' to version defaults and 'jQuery processing' to the boolean parameter. However, it does not address the 'apiVersion' parameter, and the added value is moderate.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description states 'Get EDSS documentation with automatic version discovery and jQuery processing', clearly indicating the action and unique features compared to siblings like 'get_edss_documentation'. However, 'automatic version discovery' is somewhat vague.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

No usage guidance is provided. The description does not specify when to use this tool versus its siblings (e.g., 'get_edss_documentation', 'analyze_edss_api_endpoints'), leaving the agent without context for selection.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/miroslawfranek/JDSS-REST-Documentation-MCP'

If you have feedback or need assistance with the MCP directory API, please join our Discord server