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 21 tools for managing contacts and their associated data. These tools are organized into four categories: contact management, emails, addresses, and phone numbers.
Core tools for creating, reading, updating, and deleting contacts.
Create a new contact with name, email, phone, and company information.
Permission: contacts:writeParameters: Name Type Required Description firstNamestring No The contact’s first name lastNamestring No The contact’s last name namestring No Full display name companystring No Company or organization affiliation jobTitlestring No Job title or role titlestring No Honorific or prefix (e.g., Mr, Dr) picturestring No URL to the contact’s profile picture notesstring No Internal notes and comments emailsstring[] No Array of email addresses phoneNumbersstring[] No Array of phone numbers addressesobject[] No Array of address objects
Address object: Name Type Required Description countrystring Yes Country citystring Yes City labelstring No Label for the address address1string No Address line 1 address2string No Address line 2 statestring No State postalCodestring No Postal code
Returns: The created contact object with all associated data.Get details of a specific contact by ID.
Permission: contacts:readParameters: Name Type Required Description contactIdstring (UUID) Yes The ID of the contact to retrieve
Returns: Contact object with all associated addresses, emails, and phone numbers.List contacts in the organization with pagination.
Permission: contacts:readParameters: Name Type Required Default Description limitnumber No 50 Number of contacts to return (1-100) offsetnumber No 0 Number of contacts to skip for pagination
Returns: { "contacts" : [ ... ], "count" : 150 , "limit" : 50 , "offset" : 0 }
Update an existing contact.
Permission: contacts:writeParameters: Name Type Required Description contactIdstring (UUID) Yes The ID of the contact to update firstNamestring No Update the contact’s first name lastNamestring No Update the contact’s last name namestring No Update the full display name companystring No Update the company jobTitlestring No Update the job title titlestring No Update the honorific picturestring No Update the profile picture URL notesstring No Update internal notes
Returns: The updated contact object.Delete a contact (soft delete).
Permission: contacts:deleteParameters: Name Type Required Description contactIdstring (UUID) Yes The ID of the contact to delete
Returns: The deleted contact object.Tools for managing email addresses associated with contacts.
Create a new email address for a contact.
Permission: contacts.emails:writeParameters: Name Type Required Description contactIdstring (UUID) Yes The ID of the contact emailstring Yes The email address labelstring No Label (e.g., “work”, “personal”)
Returns: The created contact email object.Get details of a specific contact email.
Permission: contacts.emails:readParameters: Name Type Required Description emailIdstring (UUID) Yes The ID of the email to retrieve
Returns: Contact email object with all details.List all email addresses for a specific contact.
Permission: contacts.emails:readParameters: Name Type Required Description contactIdstring (UUID) Yes The ID of the contact
Returns: { "emails" : [ ... ], "count" : 3 }
Update an existing contact email address.
Permission: contacts.emails:writeParameters: Name Type Required Description emailIdstring (UUID) Yes The ID of the email to update emailstring No Update the email address labelstring No Update the label
Returns: The updated contact email object.Delete a contact email address.
Permission: contacts.emails:deleteParameters: Name Type Required Description emailIdstring (UUID) Yes The ID of the email to delete
Returns: The deleted contact email object.Tools for managing physical addresses associated with contacts.
Create a new address for a contact.
Permission: contacts.addresses:writeParameters: Name Type Required Description contactIdstring (UUID) Yes The ID of the contact countrystring Yes Country citystring Yes City labelstring Yes Label for the address address1string No Address line 1 address2string No Address line 2 statestring No State postalCodestring No Postal code
Returns: The created contact address object.Get details of a specific contact address.
Permission: contacts.addresses:readParameters: Name Type Required Description addressIdstring (UUID) Yes The ID of the address to retrieve
Returns: Contact address object with all details.List all addresses for a specific contact.
Permission: contacts.addresses:readParameters: Name Type Required Default Description contactIdstring (UUID) Yes - The ID of the contact limitnumber No 10 Maximum number of results offsetnumber No 0 Offset for pagination sortOrderstring No ”asc” Sort order (“asc” or “desc”)
Returns: Array of contact address objects.Update an existing contact address.
Permission: contacts.addresses:writeParameters: Name Type Required Description addressIdstring (UUID) Yes The ID of the address to update countrystring No Update the country citystring No Update the city labelstring No Update the label address1string No Update address line 1 address2string No Update address line 2 statestring No Update the state postalCodestring No Update the postal code
Returns: The updated contact address object.Delete a contact address.
Permission: contacts.addresses:deleteParameters: Name Type Required Description addressIdstring (UUID) Yes The ID of the address to delete
Returns: The deleted contact address object.Tools for managing phone numbers associated with contacts.
Create a new phone number for a contact.
Permission: contacts.phoneNumbers:writeParameters: Name Type Required Description contactIdstring (UUID) Yes The ID of the contact phoneNumberstring Yes The phone number countryCodestring Yes Country code nationalNumberstring Yes National number labelstring Yes Label (e.g., “mobile”, “work”)
Returns: The created contact phone number object.Get details of a specific contact phone number.
Permission: contacts.phoneNumbers:readParameters: Name Type Required Description phoneNumberIdstring (UUID) Yes The ID of the phone number to retrieve
Returns: Contact phone number object with all details.List all phone numbers for a specific contact.
Permission: contacts.phoneNumbers:readParameters: Name Type Required Default Description contactIdstring (UUID) Yes - The ID of the contact limitnumber No 10 Maximum number of results offsetnumber No 0 Offset for pagination sortOrderstring No ”asc” Sort order (“asc” or “desc”)
Returns: Array of contact phone number objects.Update an existing contact phone number.
Permission: contacts.phoneNumbers:writeParameters: Name Type Required Description phoneNumberIdstring (UUID) Yes The ID of the phone number to update phoneNumberstring No Update the phone number countryCodestring No Update the country code nationalNumberstring No Update the national number labelstring No Update the label
Returns: The updated contact phone number object.Delete a contact phone number.
Permission: contacts.phoneNumbers:deleteParameters: Name Type Required Description phoneNumberIdstring (UUID) Yes The ID of the phone number to delete
Returns: The deleted contact phone number object.Next Steps
Message Tools Manage messages and threads
Authentication Learn how MCP clients authenticate to the server
