Skip to main content
Glama
miroslawfranek

Open-E JovianDSS REST API Documentation MCP Server

compare_documentation_versions

Compare the latest and trunk versions of JovianDSS API documentation, focusing on endpoints, changes, or a summary of differences.

Instructions

Compare latest and trunk versions of EDSS documentation

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
focusNoWhat to focus the comparison onsummary

Implementation Reference

  • The main handler function for 'compare_documentation_versions'. Fetches both latest and trunk documentation via HTTP and delegates to compareContent().
    async compareVersions(args) {
      const { focus = "summary" } = args;
      
      try {
        const [latestResponse, trunkResponse] = await Promise.all([
          fetch(this.legacyDocUrls.latest),
          fetch(this.legacyDocUrls.trunk)
        ]);
    
        if (!latestResponse.ok || !trunkResponse.ok) {
          throw new Error("Failed to fetch both versions");
        }
    
        const [latestContent, trunkContent] = await Promise.all([
          latestResponse.text(),
          trunkResponse.text()
        ]);
    
        const comparison = this.compareContent(latestContent, trunkContent, focus);
    
        return {
          content: [
            {
              type: "text",
              text: JSON.stringify(comparison, null, 2)
            }
          ]
        };
      } catch (error) {
        throw new Error(`Comparison failed: ${error.message}`);
      }
    }
  • Helper method that performs the actual content comparison. Compares sizes and extracts endpoint differences between latest and trunk documentation.
    compareContent(latest, trunk, focus) {
      const comparison = {
        timestamp: new Date().toISOString(),
        focus: focus
      };
    
      if (focus === "summary" || focus === "all") {
        comparison.summary = {
          latest_size: latest.length,
          trunk_size: trunk.length,
          size_difference: trunk.length - latest.length,
          identical: latest === trunk
        };
      }
    
      if (focus === "endpoints" || focus === "all") {
        const latestEndpoints = this.extractEndpoints(latest, false);
        const trunkEndpoints = this.extractEndpoints(trunk, false);
        
        comparison.endpoints = {
          latest_count: latestEndpoints.length,
          trunk_count: trunkEndpoints.length,
          latest_only: latestEndpoints.filter(le => 
            !trunkEndpoints.some(te => te.method === le.method && te.path === le.path)
          ),
          trunk_only: trunkEndpoints.filter(te => 
            !latestEndpoints.some(le => le.method === te.method && le.path === te.path)
          )
        };
      }
    
      return comparison;
    }
  • Input schema definition for 'compare_documentation_versions'. Defines the 'focus' parameter with enum options: endpoints, changes, summary, all.
    {
      name: "compare_documentation_versions", 
      description: "Compare latest and trunk versions of EDSS documentation",
      inputSchema: {
        type: "object",
        properties: {
          focus: {
            type: "string",
            enum: ["endpoints", "changes", "summary", "all"],
            default: "summary",
            description: "What to focus the comparison on"
          }
        }
      }
    },
  • index.js:195-196 (registration)
    Tool registration in the CallToolRequestSchema switch statement. Routes 'compare_documentation_versions' to the compareVersions() handler.
    case "compare_documentation_versions":
      return await this.compareVersions(args);
  • index.js:44-175 (registration)
    Tool registration in the ListToolsRequestSchema handler. Lists all available tools including compare_documentation_versions with its schema.
    this.server.setRequestHandler(ListToolsRequestSchema, async () => {
      return {
        tools: [
          {
            name: "get_edss_documentation",
            description: "Get EDSS REST API documentation (latest or trunk version)",
            inputSchema: {
              type: "object",
              properties: {
                version: {
                  type: "string",
                  enum: ["latest", "trunk"],
                  default: "latest",
                  description: "Documentation version to retrieve"
                },
                section: {
                  type: "string", 
                  description: "Optional: specific section or page to retrieve (if available)"
                }
              }
            }
          },
          {
            name: "download_edss_documentation", 
            description: "Get download link for EDSS documentation as ZIP file",
            inputSchema: {
              type: "object",
              properties: {
                download: {
                  type: "boolean",
                  default: true,
                  description: "Return download information for ZIP file"
                }
              }
            }
          },
          {
            name: "search_edss_documentation",
            description: "Search for specific terms or endpoints in EDSS documentation", 
            inputSchema: {
              type: "object",
              properties: {
                query: {
                  type: "string",
                  description: "Search term (e.g., 'patient', 'assessment', 'POST', '/api/patients')"
                },
                version: {
                  type: "string",
                  enum: ["latest", "trunk", "both"],
                  default: "latest", 
                  description: "Which version to search"
                }
              },
              required: ["query"]
            }
          },
          {
            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"
                }
              }
            }
          },
          {
            name: "compare_documentation_versions", 
            description: "Compare latest and trunk versions of EDSS documentation",
            inputSchema: {
              type: "object",
              properties: {
                focus: {
                  type: "string",
                  enum: ["endpoints", "changes", "summary", "all"],
                  default: "summary",
                  description: "What to focus the comparison on"
                }
              }
            }
          },
          {
            name: "discover_documentation_links",
            description: "Discover all available EDSS documentation by parsing dh.lan homepage",
            inputSchema: {
              type: "object",
              properties: {
                refresh: {
                  type: "boolean",
                  default: false,
                  description: "Force refresh discovery cache"
                }
              }
            }
          },
          {
            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"
                }
              }
            }
          }
        ]
      };
    });
Behavior2/5

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

No annotations are provided, and the description only says 'compare' without detailing behavioral traits like output format, side effects, or authentication needs. Minimal transparency beyond the basic action.

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

Conciseness5/5

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

A single sentence that directly states the tool's purpose without any waste, achieving maximum efficiency.

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

Completeness3/5

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

For a simple tool with one parameter and no output schema, the description is minimal but sufficient to convey core purpose. Lacks details on comparison output or behavior, which could aid agent understanding, especially given sibling tools.

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 100% with the 'focus' parameter described, but the tool description adds no extra meaning to how the parameter affects behavior. Baseline of 3 is appropriate.

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

Purpose5/5

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

The description uses specific verb 'compare' and resource 'latest and trunk versions of EDSS documentation', clearly distinguishing it from sibling tools like analyze, discover, or search.

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

Usage Guidelines3/5

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

The description implies usage for comparing versions but does not explicitly state when to use this tool over alternatives or provide exclusions, such as when to use analyze_edss_api_endpoints instead.

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