Documentation Index Fetch the complete documentation index at: https://docs.shingleai.com/llms.txt
Use this file to discover all available pages before exploring further.
The ShingleAI MCP server provides 10 tools for managing customers and their transactions. These tools are organized into two categories: customers and customer transactions.
Customers Core tools for creating, reading, updating, and deleting customer records.
createCustomer Create a new customer record with business association and contact information.
Permission: customers:writeParameters: Name Type Required Description businessIdstring (UUID) Yes The ID of the business this customer belongs to typestring Yes Customer type (e.g., individual, business, enterprise) contactIdstring (UUID) | null No Optional reference to an existing contact record namestring | null No Customer display name emailstring | null No Primary email address phonestring | null No Primary phone number notesstring | null No Internal notes and comments about the customer statusstring | null No Customer status (e.g., active, inactive, pending) customerSincestring | null No Date when the customer relationship began (ISO 8601)
Returns: The created customer object.getCustomer Get a specific customer by ID.
Permission: customers:readParameters: Name Type Required Description idstring (UUID) Yes The ID of the customer to retrieve
Returns: Customer object, or null if not found.listCustomers List all customers for the organization with pagination.
Permission: customers:readParameters: Name Type Required Default Description limitnumber No 10 Number of customers to return (1-100) offsetnumber No 0 Number of customers to skip for pagination sortOrderstring No ”desc” Sort order by creation date (“asc” or “desc”)
Returns: { "customers" : [ ... ], "count" : 10 , "limit" : 10 , "offset" : 0 }
updateCustomer Update an existing customer record.
Permission: customers:writeParameters: Name Type Required Description idstring (UUID) Yes The ID of the customer to update businessIdstring (UUID) No The ID of the business this customer belongs to contactIdstring (UUID) | null No Reference to an existing contact record typestring No Customer type (e.g., individual, business, enterprise) namestring | null No Customer display name emailstring | null No Primary email address phonestring | null No Primary phone number notesstring | null No Internal notes and comments about the customer statusstring | null No Customer status (e.g., active, inactive, pending) customerSincestring | null No Date when the customer relationship began (ISO 8601)
Returns: The updated customer object.deleteCustomer Delete a customer (soft delete).
Permission: customers:deleteParameters: Name Type Required Description idstring (UUID) Yes The ID of the customer to delete
Returns: The deleted customer object.Customer Transactions Tools for recording and managing financial transactions associated with customers.
createCustomerTransaction Create a new customer transaction to record a financial activity.
Permission: customers.transactions:writeParameters: Name Type Required Description customerIdstring (UUID) Yes UUID of the customer this transaction belongs to businessIdstring (UUID) Yes UUID of the business associated with the transaction amountstring Yes Transaction amount as a string (to handle decimal precision) currencystring Yes Currency code (e.g., USD, EUR) statusstring Yes Transaction status (e.g., pending, completed, failed) typestring Yes Transaction type (e.g., purchase, refund, subscription) descriptionstring | null No Optional description of the transaction transactionDatestring | null No Optional date when the transaction occurred (ISO 8601 format)
Returns: The created customer transaction object.getCustomerTransaction Get a specific customer transaction by its ID.
Permission: customers.transactions:readParameters: Name Type Required Description transactionIdstring (UUID) Yes UUID of the customer transaction to retrieve
Returns: Customer transaction object, or null if not found.listCustomerTransactions List all transactions for a specific customer with pagination support.
Permission: customers.transactions:readParameters: Name Type Required Default Description customerIdstring (UUID) Yes - UUID of the customer whose transactions to retrieve limitnumber No 10 Maximum number of items to return (1-100) offsetnumber No 0 Number of items to skip for pagination sortOrderstring No ”desc” Sort order by creation date (“asc” or “desc”)
Returns: { "transactions" : [ ... ], "count" : 25 , "limit" : 10 , "offset" : 0 }
updateCustomerTransaction Update an existing customer transaction - all fields are optional except transactionId.
Permission: customers.transactions:writeParameters: Name Type Required Description transactionIdstring (UUID) Yes UUID of the customer transaction to update businessIdstring (UUID) No Update the business associated with the transaction amountstring No Update the transaction amount as a string (to handle decimal precision) currencystring No Update the currency code (e.g., USD, EUR) statusstring No Update the transaction status (e.g., pending, completed, failed) typestring No Update the transaction type (e.g., purchase, refund, subscription) descriptionstring | null No Update the description of the transaction transactionDatestring | null No Update the date when the transaction occurred (ISO 8601 format)
Returns: The updated customer transaction object.deleteCustomerTransaction Delete a customer transaction (soft delete).
Permission: customers.transactions:deleteParameters: Name Type Required Description transactionIdstring (UUID) Yes UUID of the customer transaction to delete
Returns: The deleted customer transaction object.Next Steps
Contact Tools Manage contacts that may be linked to customers
Authentication Learn how MCP clients authenticate to the server
