@zydon/mcp-server-portal

MCP (Model Context Protocol) Server for Zydon Portal. This server provides AI assistants with tools to interact with the Zydon Portal API.

Installation

You don't need to install this package manually. Use it directly with npx:

npx @zydon/mcp-server-portal

Configuration

For Windsurf IDE

Add to your .windsurf/mcp.json:

{
  "mcpServers": {
    "zydon-portal": {
      "command": "npx",
      "args": ["-y", "@zydon/mcp-server-portal"]
    }
  }
}

For Claude Desktop

Add to your Claude Desktop configuration file:

MacOS: ~/Library/Application Support/Claude/claude_desktop_config.json Windows: %APPDATA%\Claude\claude_desktop_config.json

{
  "mcpServers": {
    "zydon-portal": {
      "command": "npx",
      "args": ["-y", "@zydon/mcp-server-portal"]
    }
  }
}

For Cline (VS Code Extension)

Add to your Cline MCP settings:

{
  "mcpServers": {
    "zydon-portal": {
      "command": "npx",
      "args": ["-y", "@zydon/mcp-server-portal"]
    }
  }
}

Available Tools

retrieve_portal_appearance

Retrieves the appearance configuration of a portal by its ingress (domain).

Parameters:

• ingress (string, required): The domain/ingress of the portal (e.g., "portal.example.com")

Returns: Portal appearance information including:

• Title and branding
• Color schemes
• Images and logos
• Menu configurations
• Floating button settings
• Other visual customizations

Example:

{
  "ingress": "portal.zydon.com.br"
}

retrieve_payment_link_order

Retrieves an order through a public payment link ID.

Parameters:

• ingress (string, required): The domain/ingress of the portal (e.g., "portal.example.com")
• paymentLinkId (string, required): The public payment link ID

Returns: Complete order information including:

• Order items and quantities
• Summary values (subtotal, discount, freight, total)
• Payment link status (PENDING, PAID, EXPIRED, CANCELLED)
• Delivery information
• Financial details and payment methods
• Order status history
• Partner information

Example:

{
  "ingress": "portal.zydon.com.br",
  "paymentLinkId": "abc123xyz"
}

list_shop_products

Lists products from the portal's shop/storefront with support for pagination, search, filters, and sorting.

Parameters:

• ingress (string, required): The domain/ingress of the portal (e.g., "portal.example.com")
• page (number, optional): Page number (starts at 0, default: 0)
• perPage (number, optional): Items per page (default: 25)
• sort (string, optional): Field to sort by
• dir (string, optional): Sort direction - "asc" or "desc" (default: "asc")
• search (string, optional): Search term to filter products by name, code, etc.
• category_id (string, optional): Category ID to filter products
• sort_field_id (string, optional): Custom sort field ID

Returns: Paginated list of products with detailed information including:

• Product ID, name, and description
• Prices and discounts
• Product images
• Stock availability
• Categories and brands
• Product attributes and specifications
• SEO information

Example - Basic listing:

{
  "ingress": "portal.zydon.com.br"
}

Example - With pagination:

{
  "ingress": "portal.zydon.com.br",
  "page": 0,
  "perPage": 50
}

Example - With search and filters:

{
  "ingress": "portal.zydon.com.br",
  "search": "notebook",
  "category_id": "cat-123",
  "dir": "desc"
}

get_shop_product_by_id

Retrieves detailed information about a specific product from the shop by its ID.

Parameters:

• ingress (string, required): The domain/ingress of the portal (e.g., "portal.example.com")
• productId (string, required): The product ID

Returns: Complete product details including:

• Product ID, name, and full description
• Prices, discounts, and promotions
• Multiple product images
• Stock availability and quantity
• Categories and brands
• Technical specifications and attributes
• SEO metadata (title, description, keywords)
• Related products information

Example:

{
  "ingress": "portal.zydon.com.br",
  "productId": "prod-12345"
}

list_shop_categories_tree

Lists all shop categories in a hierarchical tree structure.

Parameters:

• ingress (string, required): The domain/ingress of the portal (e.g., "portal.example.com")

Returns: Hierarchical tree structure of categories including:

• Category ID, name, and description
• Parent-child relationships
• Subcategories nested within parent categories
• Category images and icons
• Category order/position
• Active/inactive status
• Complete navigation structure

Example:

{
  "ingress": "portal.zydon.com.br"
}

Response structure example:

[
  {
    "id": "cat-1",
    "name": "Electronics",
    "children": [
      {
        "id": "cat-1-1",
        "name": "Computers",
        "children": [...]
      },
      {
        "id": "cat-1-2",
        "name": "Smartphones",
        "children": [...]
      }
    ]
  }
]

API Endpoint

This server connects to: https://portal-homologation.zydon.com.br/api

Requirements

• Node.js >= 18.0.0

License

MIT

Support

For issues and questions, please contact Zydon support or open an issue on the repository.