Skip to main content
Glama
miroslawfranek

Open-E JovianDSS REST API Documentation MCP Server

analyze_edss_api_endpoints

Extract and analyze REST API endpoints from Open-E JovianDSS documentation. Choose version and request detailed analysis of parameters and schemas.

Instructions

Extract and analyze API endpoints from EDSS documentation

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
versionNoDocumentation version to analyzelatest
detailedNoInclude detailed analysis of endpoints, parameters, and schemas

Implementation Reference

  • Main handler function for the analyze_edss_api_endpoints tool. Fetches documentation HTML from the specified version URL, calls extractEndpoints() to parse endpoints, and returns JSON results.
    async analyzeEndpoints(args) {
      const { version = "latest", detailed = false } = args;
      
      try {
        const url = version === "latest" ? this.legacyDocUrls.latest : this.legacyDocUrls.trunk;
        const response = await fetch(url);
        
        if (!response.ok) {
          throw new Error(`Failed to fetch documentation: ${response.status}`);
        }
    
        const content = await response.text();
        const endpoints = this.extractEndpoints(content, detailed);
    
        return {
          content: [
            {
              type: "text", 
              text: JSON.stringify({
                version: version,
                endpoints: endpoints,
                total: endpoints.length,
                detailed: detailed
              }, null, 2)
            }
          ]
        };
      } catch (error) {
        throw new Error(`Analysis failed: ${error.message}`);
      }
    }
  • Input schema definition for analyze_edss_api_endpoints. Defines two parameters: 'version' (enum: latest/trunk, default latest) and 'detailed' (boolean, default false).
    {
      name: "analyze_edss_api_endpoints",
      description: "Extract and analyze API endpoints from EDSS documentation",
      inputSchema: {
        type: "object",
        properties: {
          version: {
            type: "string",
            enum: ["latest", "trunk"],
            default: "latest",
            description: "Documentation version to analyze"
          },
          detailed: {
            type: "boolean",
            default: false,
            description: "Include detailed analysis of endpoints, parameters, and schemas"
          }
        }
      }
    },
  • index.js:192-193 (registration)
    Registration of the analyze_edss_api_endpoints tool in the CallToolRequestSchema switch statement, dispatching to this.analyzeEndpoints(args).
    case "analyze_edss_api_endpoints":
      return await this.analyzeEndpoints(args);
  • extractEndpoints() helper: Parses HTML content for HTTP method + path patterns (GET/POST/PUT/DELETE/PATCH). When detailed=true, also extracts endpoint descriptions and parameters.
    extractEndpoints(content, detailed) {
      const endpoints = [];
      const endpointRegex = /(GET|POST|PUT|DELETE|PATCH)\s+([\/\w\-\{\}\.]+)/g;
      let match;
    
      while ((match = endpointRegex.exec(content)) !== null) {
        const endpoint = {
          method: match[1],
          path: match[2]
        };
    
        if (detailed) {
          // Extract additional details if requested
          endpoint.description = this.extractEndpointDescription(content, match.index);
          endpoint.parameters = this.extractParameters(content, match.index);
        }
    
        endpoints.push(endpoint);
      }
    
      return endpoints;
    }
  • extractEndpointDescription() helper: Extracts description text from a <p> tag within 200 characters before the endpoint match.
    extractEndpointDescription(content, index) {
      const beforeContext = content.substring(Math.max(0, index - 200), index);
      const descMatch = beforeContext.match(/<p[^>]*>(.*?)<\/p>/s);
      return descMatch ? descMatch[1].replace(/<[^>]+>/g, '').trim() : '';
    }
  • extractParameters() helper: Extracts parameter name/type pairs from JSON-like patterns within 500 characters after the endpoint match.
    extractParameters(content, index) {
      const afterContext = content.substring(index, Math.min(content.length, index + 500));
      const paramRegex = /"([^"]+)"\s*:\s*"([^"]+)"/g;
      const parameters = [];
      let paramMatch;
    
      while ((paramMatch = paramRegex.exec(afterContext)) !== null) {
        parameters.push({
          name: paramMatch[1],
          type: paramMatch[2]
        });
      }
    
      return parameters;
    }
Behavior2/5

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

No annotations are provided, and the description does not disclose behavioral traits such as whether the tool is read-only, what it outputs, or side effects. The minimal 'extract and analyze' leaves much to inference.

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 that is easy to parse. However, it could benefit from slightly more structure or bullet points for clarity.

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?

For a tool with multiple siblings and no output schema, the description is insufficient. It does not explain what 'analyze' entails, the output format, or how it differs from similar tools like 'get_edss_documentation_enhanced'.

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 description coverage is 100%, so the schema already explains the 'version' and 'detailed' parameters. The tool description adds no additional meaning beyond what is in the schema.

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 clearly states the action ('extract and analyze') and the resource ('API endpoints from EDSS documentation'). It is distinguishable from siblings like 'get_edss_documentation', but does not explicitly contrast with them.

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 guidance on when to use this tool versus alternatives like 'search_edss_documentation' or 'get_edss_documentation_enhanced'. The description lacks any contextual usage hints.

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