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 20 tools for managing businesses, their profile, offerings, and online and physical presences. These tools are organized into five categories: businesses, business profile, offerings, online presences, and physical presences.
Businesses Core tools for reading and updating businesses. Businesses are provisioned with the organization, so there are no create or delete tools.
getBusiness Get details for a specific business by ID.
Permission: businesses:readParameters: Name Type Required Description businessIdstring (UUID) Yes ID of the business to retrieve
Returns: Business object, or null if not found.listBusinesses List all businesses in the organization.
Permission: businesses:readParameters: Name Type Required Default Description limitnumber No 10 Maximum number of items to return (max: 100) offsetnumber No 0 Number of items to skip for pagination sortOrderstring No ”desc” Sort order by creation date (“asc” or “desc”)
Returns: { "businesses" : [ ... ], "count" : 3 , "limit" : 10 , "offset" : 0 }
updateBusiness Update an existing business by ID.
Permission: businesses:writeParameters: Name Type Required Description idstring (UUID) Yes ID of the business to update namestring No The name of the business
Stripe Connect-related fields on the business record are managed by the Stripe integration — do not pass them in here, as they are overwritten or ignored.
Returns: The updated business object.Business Profile Tools for reading and updating the descriptive profile of a business. The profile is created alongside the business, so there is no create, list, or delete tool — there is exactly one profile per business.
getBusinessProfile Get the detailed profile of a business by ID.
Permission: businesses.profiles:readParameters: Name Type Required Description businessIdstring (UUID) Yes ID of the business whose profile to retrieve (profile shares the business ID)
Returns: Business profile object, or null if not found.updateBusinessProfile Update the profile information of a business.
Permission: businesses.profiles:writeParameters: Name Type Required Description idstring (UUID) Yes The ID of the business profile to update descriptionstring | null No A new detailed description of the business (optional) industriesstring[] | null No New industries the business operates in (optional) dataRecord<string, unknown> | null No Additional business data as key-value pairs (optional)
Returns: The updated business profile object.Offerings Tools for managing the products and services a business offers.
createBusinessOffering Create a new product or service offering for a business.
Permission: businesses.offerings:writeParameters: Name Type Required Description businessIdstring (UUID) Yes The ID of the business this offering belongs to namestring Yes The name of the offering descriptionstring | null No A description of the offering (optional) isServiceboolean | null No Whether this is a service (true) or product (false) - optional
Returns: The created business offering object.getBusinessOffering Get details of a specific business offering by ID.
Permission: businesses.offerings:readParameters: Name Type Required Description idstring (UUID) Yes The ID of the business offering to retrieve
Returns: Business offering object, or null if not found.listBusinessOfferings List all products and services offered by a business.
Permission: businesses.offerings:readParameters: Name Type Required Default Description businessIdstring (UUID) Yes - The ID of the business to list offerings for limitnumber No 100 Maximum number of results offsetnumber No 0 Offset for pagination
Returns: { "offerings" : [ ... ], "count" : 12 , "limit" : 100 , "offset" : 0 }
updateBusinessOffering Update details of an existing business offering.
Permission: businesses.offerings:writeParameters: Name Type Required Description idstring (UUID) Yes The ID of the business offering to update namestring No The new name for the offering (optional) descriptionstring | null No A new description for the offering (optional) isServiceboolean | null No Whether this is a service (true) or product (false) - optional
Returns: The updated business offering object.deleteBusinessOffering Delete a business offering (soft delete).
Permission: businesses.offerings:deleteParameters: Name Type Required Description idstring (UUID) Yes The ID of the business offering to delete
Returns: The deleted business offering object.Online Presences Tools for managing a business’s online presence — websites, social media profiles, marketplace listings, and similar.
createBusinessOnlinePresence Create a new online presence for a business (website, social media, marketplace, etc.).
Permission: businesses.online-presences:writeParameters: Name Type Required Description businessIdstring (UUID) Yes The ID of the business this online presence belongs to namestring Yes The name of the online presence (e.g., “Company Website”, “Facebook Page”) urlstring | null No The URL of the online presence (optional) descriptionstring | null No A description of the online presence (optional) typestring | null No The type of online presence (e.g., “website”, “social_media”, “marketplace”) (optional) providerstring | null No The provider or platform (e.g., “facebook”, “linkedin”, “amazon”) (optional)
Returns: The created business online presence object.getBusinessOnlinePresence Get details of a specific business online presence by ID.
Permission: businesses.online-presences:readParameters: Name Type Required Description onlinePresenceIdstring (UUID) Yes The ID of the business online presence to retrieve
Returns: Business online presence object, or null if not found.listBusinessOnlinePresences List all online presences for a specific business.
Permission: businesses.online-presences:readParameters: Name Type Required Default Description businessIdstring (UUID) Yes - The ID of the business to list online presences for limitnumber No 100 Maximum number of results offsetnumber No 0 Offset for pagination
Returns: { "onlinePresences" : [ ... ], "count" : 4 , "limit" : 100 , "offset" : 0 }
updateBusinessOnlinePresence Update an existing business online presence - all fields are optional except onlinePresenceId.
Permission: businesses.online-presences:writeParameters: Name Type Required Description onlinePresenceIdstring (UUID) Yes The ID of the business online presence to update namestring No Update the online presence name urlstring | null No Update the URL descriptionstring | null No Update the description typestring | null No Update the type of online presence providerstring | null No Update the provider or platform
Returns: The updated business online presence object.deleteBusinessOnlinePresence Delete a business online presence (soft delete).
Permission: businesses.online-presences:deleteParameters: Name Type Required Description onlinePresenceIdstring (UUID) Yes The ID of the business online presence to delete
Returns: The deleted business online presence object.Physical Presences Tools for managing a business’s physical locations — offices, stores, warehouses, and similar.
createBusinessPhysicalPresence Create a new physical location (office, store, warehouse, etc.) for a business.
Permission: businesses.physical-presences:writeParameters: Name Type Required Description businessIdstring (UUID) Yes The ID of the business this physical location belongs to namestring Yes The name of the physical location (e.g., “Main Office”, “Downtown Store”) descriptionstring | null No A description of the physical location (optional) addressstring | null No The full address of the physical location (optional)
Returns: The created business physical presence object.getBusinessPhysicalPresence Get details of a specific business physical location by ID.
Permission: businesses.physical-presences:readParameters: Name Type Required Description physicalPresenceIdstring (UUID) Yes The ID of the business physical presence to retrieve
Returns: Business physical presence object, or null if not found.listBusinessPhysicalPresences List all physical locations (offices, stores, etc.) for a business.
Permission: businesses.physical-presences:readParameters: Name Type Required Default Description businessIdstring (UUID) Yes - The ID of the business to list physical locations for limitnumber No 100 Maximum number of results offsetnumber No 0 Offset for pagination
Returns: { "physicalPresences" : [ ... ], "count" : 2 , "limit" : 100 , "offset" : 0 }
updateBusinessPhysicalPresence Update an existing business physical location - all fields are optional except physicalPresenceId.
Permission: businesses.physical-presences:writeParameters: Name Type Required Description physicalPresenceIdstring (UUID) Yes The ID of the business physical presence to update namestring No Update the physical location name descriptionstring | null No Update the description addressstring | null No Update the address
Returns: The updated business physical presence object.deleteBusinessPhysicalPresence Delete a business physical location (soft delete).
Permission: businesses.physical-presences:deleteParameters: Name Type Required Description physicalPresenceIdstring (UUID) Yes The ID of the business physical presence to delete
Returns: The deleted business physical presence object.Next Steps
Customer Tools Manage customers and their relationships with your business
Authentication Learn how MCP clients authenticate to the server
