brinkcommerce-dev-mcp 0.1.0-beta.1

package/dist/handlers/registry.js

@@ -0,0 +1,64 @@
+/**
+ * Registry for managing tool handlers
+ *
+ * This registry enables a plugin-like architecture where tools can be
+ * registered from different modules without modifying the core server code.
+ */
+export class ToolRegistry {
+    handlers = new Map();
+    /**
+     * Register a new tool handler
+     * @throws Error if a handler with the same name is already registered
+     */
+    register(registration) {
+        if (this.handlers.has(registration.name)) {
+            throw new Error(`Handler for tool "${registration.name}" already registered`);
+        }
+        this.handlers.set(registration.name, registration);
+    }
+    /**
+     * Get a handler function by tool name
+     * @returns The handler function or undefined if not found
+     */
+    getHandler(name) {
+        return this.handlers.get(name)?.handler;
+    }
+    /**
+     * Get full registration info for a tool
+     * @returns The registration or undefined if not found
+     */
+    getRegistration(name) {
+        return this.handlers.get(name);
+    }
+    /**
+     * Get all registered tools
+     * @returns Array of all tool registrations
+     */
+    getAllTools() {
+        return Array.from(this.handlers.values());
+    }
+    /**
+     * Check if a handler exists for a tool
+     */
+    hasHandler(name) {
+        return this.handlers.has(name);
+    }
+    /**
+     * Get the count of registered tools
+     */
+    get size() {
+        return this.handlers.size;
+    }
+    /**
+     * Unregister a tool (primarily for testing)
+     */
+    unregister(name) {
+        return this.handlers.delete(name);
+    }
+    /**
+     * Clear all registrations (primarily for testing)
+     */
+    clear() {
+        this.handlers.clear();
+    }
+}

package/dist/help-content.d.ts

@@ -0,0 +1,57 @@
+/**
+ * Help content and contextual messages for the MCP server
+ */
+interface DocsConfig {
+    baseUrl: string;
+    sections: {
+        gettingStarted: string;
+        essentials: string;
+        apiArchitecture: string;
+        authentication: string;
+        guides: string;
+        environmentSetup: string;
+        firstRequest: string;
+        workflows: string;
+        integrations: string;
+        apiReferences: string;
+        events: string;
+        support: string;
+        troubleshooting: string;
+    };
+}
+interface MerchantPortalAcademyConfig {
+    baseUrl: string;
+    categories: {
+        dashboard: string;
+        discounts: string;
+        orders: string;
+        products: string;
+        customer: string;
+        stores: string;
+        settings: string;
+        info: string;
+        user: string;
+    };
+}
+export declare const platformOverview: (docsConfig: DocsConfig, mpAcademyConfig?: MerchantPortalAcademyConfig) => string;
+export declare const listApisContent: (coreApis: string[], shopperApis: string[], integrationApis: string[]) => string;
+export declare const listEndpointsContent: (apiName: string, endpointList: string) => string;
+export declare const errorMessages: {
+    apiNotFound: (apiName: string, availableApis: string[]) => string;
+    endpointNotFound: (method: string, path: string, apiName: string) => string;
+    noEndpointsFound: (apiName: string) => string;
+    noSchemasFound: (apiName: string) => string;
+    schemaNotFound: (schemaName: string, apiName: string) => string;
+    noSearchResults: (query: string) => string;
+};
+export declare const contextualTips: {
+    get: string;
+    post: string;
+    put: string;
+    patch: string;
+    delete: string;
+};
+export declare const nextSteps: {
+    endpointDetails: string;
+};
+export {};

package/dist/help-content.js

@@ -0,0 +1,223 @@
+/**
+ * Help content and contextual messages for the MCP server
+ */
+export const platformOverview = (docsConfig, mpAcademyConfig) => `# Brink Commerce Platform Overview
+
+👋 **Welcome! You're in the right place.** This overview will help you understand what you can build and how to get started effectively.
+
+## What is Brink Commerce?
+Brink Commerce (also known as BrinkCommerce or simply "Brink") is a modern headless e-commerce platform built for composable commerce. It provides enterprise-grade infrastructure for building custom shopping experiences across web, mobile, and other channels.
+
+**Note**: "Brink", "Brink Commerce", and "BrinkCommerce" all refer to the same platform.
+
+## Core Capabilities
+• **Product Management** - Catalog, variants, attributes, categories
+• **Order Management** - Cart, checkout, order processing, fulfillment
+• **Inventory & Stock** - Real-time stock levels, reservations, warehouses
+• **Pricing** - Dynamic pricing, market-specific prices, reference prices
+• **Discount Management** - Bundle groups, discount codes, discount runs
+• **Tax Management** - Tax groups, tax markets, country-specific tax rates
+• **Customer Management** - Profiles, authentication, segments
+• **Payment Processing** - Integrated with Klarna, Adyen, Svea, Walley, and more
+
+## Architecture
+• **API-First** - RESTful APIs with OpenAPI specifications
+• **Microservices** - Modular services you can compose as needed
+• **Event-Driven** - Webhooks and events for real-time updates
+• **Multi-Tenant** - Built for B2C, B2B, and marketplace models
+• **Global Ready** - Multi-currency, multi-language, multi-market
+• **Full Data Access** - APIs return complete data sets (no pagination needed)
+
+## How to Use This MCP Server
+
+### 🏁 Start Here - Understanding First
+1. **get_docs_info** - Get platform overview and documentation (START HERE!)
+2. **search_schemas [keyword]** - Find specific data models and concepts
+3. **list_apis** - Browse available APIs once you understand the platform
+
+### 🔍 Deep Dive Flow  
+1. **get_api_info [api-name]** - Understand what an API does
+2. **list_endpoints [api-name]** - See available operations
+3. **get_endpoint_details** - Get implementation specifics
+
+### 💡 Common Approaches
+• **"How does Brink Commerce work?"** → Start with \`get_docs_info\`
+• **"I need to handle products"** → \`search_schemas "product"\` then explore relevant APIs
+• **"How do I process payments?"** → \`get_docs_info\` first, then \`search_schemas "payment"\`
+• **"What can I build with this?"** → \`get_docs_info\` for capabilities and examples
+
+## Available API Categories
+• **Core Commerce**: Product, Order, Inventory, Price, Discount, Tax, Store Management
+• **Payment Providers**: Klarna, Adyen, Svea, Walley, Zaver, and more
+• **Integrations**: Voyado, NShift, Ingrid, gift cards, loyalty programs
+
+## Documentation
+
+**Base URL**: ${docsConfig.baseUrl}
+
+**Key Sections**:
+• Getting Started: ${docsConfig.baseUrl}${docsConfig.sections.gettingStarted}
+• API Architecture: ${docsConfig.baseUrl}${docsConfig.sections.apiArchitecture}
+• Authentication: ${docsConfig.baseUrl}${docsConfig.sections.authentication}
+• API References: ${docsConfig.baseUrl}${docsConfig.sections.apiReferences}
+• Integrations: ${docsConfig.baseUrl}${docsConfig.sections.integrations}
+
+**Quick Search**: ${docsConfig.baseUrl}?=${mpAcademyConfig
+    ? `
+
+## Merchant Portal Academy
+
+**For Merchants & Store Managers**: Learn how to use the Brink Commerce Merchant Portal to manage your store operations.
+
+**Academy URL**: ${mpAcademyConfig.baseUrl}
+
+**Training Categories**:
+• **${mpAcademyConfig.categories.dashboard}** - Business overview, sales metrics, performance tracking
+• **${mpAcademyConfig.categories.orders}** - Order management, cancellations, modifications, refunds
+• **${mpAcademyConfig.categories.products}** - Product catalog, inventory, variants, categories
+• **${mpAcademyConfig.categories.discounts}** - Price rules, campaigns, vouchers, promotions
+• **${mpAcademyConfig.categories.customer}** - Customer profiles, segments, order history
+• **${mpAcademyConfig.categories.stores}** - Store configuration, multi-store management
+• **${mpAcademyConfig.categories.settings}** - Environment setup, integrations, user management
+• **${mpAcademyConfig.categories.user}** - User roles, permissions, access control
+• **${mpAcademyConfig.categories.info}** - Platform updates, features, roadmap
+
+**Who should use what?**
+- **Developers/Integrators**: Use this MCP server and API documentation for building applications
+- **Merchants/Store Managers**: Use Merchant Portal Academy for daily store operations and management`
+    : ""}`;
+export const listApisContent = (coreApis, shopperApis, integrationApis) => `# Available Brink Commerce APIs
+
+📚 **First time here?** Try \`get_docs_info\` first to understand the platform!
+
+Brink (BrinkCommerce) is a headless e-commerce platform providing composable commerce infrastructure. Here are the available APIs:
+
+## Core Commerce APIs
+${coreApis.join("\n\n") || "No core APIs available"}
+
+## Payment & Shopper APIs  
+${shopperApis.join("\n\n") || "No shopper APIs available"}
+
+## Integration APIs
+${integrationApis.join("\n\n") || "No integration APIs available"}
+
+## 🎯 Better Approach
+Instead of browsing APIs randomly, try:
+• \`get_docs_info\` - Understand what you can build and how
+• \`search_schemas "<need>"\` - Find data models for your specific use case
+• \`get_api_info "<api-name>"\` - Deep dive into a relevant API
+
+💡 **Tip**: API names (shown in backticks) are what you'll use with other tools.`;
+export const listEndpointsContent = (apiName, endpointList) => `# Endpoints for ${apiName}
+
+${endpointList}
+
+## API Characteristics
+• **Full responses** - Brink APIs return complete data sets without pagination
+• **Filtering** - Use query parameters to filter results when available
+• **Bulk operations** - Many APIs support batch operations for efficiency
+
+## Next Steps
+• Use \`get_endpoint_details\` for detailed parameter and schema information
+• Use \`get_schema\` to understand data models
+• Check authentication requirements in the documentation`;
+export const errorMessages = {
+    apiNotFound: (apiName, availableApis) => `❌ API specification '${apiName}' not found.
+
+**Note**: Looking for Brink/BrinkCommerce APIs? The API names don't include "brink" prefix.
+
+**Available APIs include:**
+${availableApis.map((name) => `• ${name}`).join("\n")}
+
+**Common API names:**
+• product-management (Brink Product API)
+• order-management (Brink Order API)  
+• shopper-api (Brink Shopper API)
+• shopper-klarna, shopper-adyen (Brink Payment APIs)
+
+**Suggestions:**
+• Use \`get_docs_info\` to understand the platform first
+• Use \`search_schemas "<keyword>"\` to find what you need across all APIs
+• Use \`list_apis\` to browse available APIs with descriptions
+• Check the spelling and case of the API name`,
+    endpointNotFound: (method, path, apiName) => `❌ Endpoint ${method} ${path} not found in API '${apiName}'.
+
+**Suggestions:**
+• Use \`list_endpoints "${apiName}"\` to see all available endpoints
+• Check the exact path format (e.g., /products/{id} not /products/:id)
+• Verify the HTTP method is correct
+
+**Looking for something specific?**
+• Use \`search_schemas "<keyword>"\` to find related data models
+• Try \`get_api_info "${apiName}"\` to explore this API`,
+    noEndpointsFound: (apiName) => `❌ No endpoints found for API '${apiName}' with the specified filters.
+
+**Suggestions:**
+• Try \`get_docs_info\` first to understand the platform
+• Use \`search_schemas "<keyword>"\` to find what you need across all APIs
+• Try \`list_endpoints "${apiName}"\` without filters to see all endpoints
+• Use \`get_api_info "${apiName}"\` to verify the API exists`,
+    noSchemasFound: (apiName) => `❌ No schemas found for API '${apiName}'.
+
+**Suggestions:**
+• Try \`get_docs_info\` to understand the platform architecture first
+• Use \`search_schemas "<keyword>"\` to find data models across all APIs
+• Use \`get_api_info "${apiName}"\` to check if this API has schemas
+• Some APIs might not define explicit schemas - check endpoints directly`,
+    schemaNotFound: (schemaName, apiName) => `❌ Schema '${schemaName}' not found in API '${apiName}'.
+
+**Suggestions:**
+• Use \`list_schemas "${apiName}"\` to see all available schemas
+• Check the exact case and spelling (e.g., "Product" not "product")
+• Try \`search_schemas "${schemaName}"\` to find it across all APIs
+• Schema names are usually PascalCase (Product, Order, Customer)
+
+**Common schema names:**
+• Product, ProductVariant, Category
+• Order, Cart, LineItem  
+• Customer, Address, Payment
+• Price, Stock, Discount`,
+    noSearchResults: (query) => `❌ No schemas found matching '${query}'.
+
+**Try these common search terms:**
+• **"email"** - Find customer/user schemas
+• **"price"** - Find pricing and product schemas  
+• **"stock"** or **"inventory"** - Find stock management schemas
+• **"customer"** - Find customer-related schemas
+• **"product"** - Find product catalog schemas
+• **"order"** - Find order management schemas
+• **"payment"** - Find payment-related schemas
+
+**Tips:**
+• Try broader terms (e.g., "user" instead of "username") 
+• Search for singular forms (e.g., "product" not "products")
+• Use \`get_docs_info\` to understand platform capabilities first`,
+};
+export const contextualTips = {
+    get: `**💡 GET Request Tips:**
+• Use query parameters for filtering
+• Review response schema for data structure
+• Check if any query parameters are required`,
+    post: `**💡 POST Request Tips:**
+• Review required fields in request body
+• Check validation rules in schema
+• Note any unique constraints`,
+    put: `**💡 Update Tips:**
+• PUT replaces entire resource
+• PATCH updates specific fields
+• Check which fields are immutable`,
+    patch: `**💡 Update Tips:**
+• PUT replaces entire resource
+• PATCH updates specific fields
+• Check which fields are immutable`,
+    delete: `**💡 DELETE Tips:**
+• Check if cascading deletes occur
+• Review any constraints or dependencies
+• Note if soft delete is used`,
+};
+export const nextSteps = {
+    endpointDetails: `**Next Steps:**
+• Use \`list_schemas\` to explore data models
+• Check authentication requirements in documentation
+• Review the full documentation for implementation examples`,
+};

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {};