Skip to main content

Using the SyncHive MCP Server

Connect AI assistants and AI applications to SyncHive through the Model Context Protocol (MCP).

The SyncHive MCP server allows an AI application to:

  • search and retrieve content from the SyncHive documentation
  • identify the Workspaces and Hives you can access
  • explore a Hive's current schema
  • retrieve complete table and shape definitions
  • explore the Schema Library from the perspective of a selected Hive

You can ask questions in natural language and receive answers based on current information from SyncHive and docs.synchive.com.

What Is MCP?​

Model Context Protocol (MCP) is a standard that allows AI applications to connect to external systems and information sources.

The SyncHive MCP server uses OAuth to connect securely to your SyncHive account. After you sign in, it knows which user you are and which Workspaces and Hives you can access.

The connection does not grant any additional permissions. It can only access SyncHive resources and features that you already have permission to use.

Connect to SyncHive​

To add the SyncHive MCP server to an AI application:

  1. Open the MCP or integrations settings in your AI application
  2. Choose the option to add an MCP server
  3. Enter the following URL: https://mcp.synchive.com/mcp
  4. Select OAuth as the authentication method
  5. Follow the prompts to sign in to SyncHive and authorize the connection
  6. Confirm that the SyncHive tools are available

Each MCP connection is linked to the SyncHive user who signs in. If you connect through another AI application, you may need to sign in and authorize that connection separately.

What You Can Do​

Search the SyncHive Documentation​

The MCP server can search docs.synchive.com and return relevant pages, sections, excerpts and source links.

For example, you can ask:

  • What filters can my app use for data stored in SyncHive?
  • How do external IDs work?
  • How can I export my data?
  • What is the difference between a Connector and an Integration?
  • How should I handle a specific SyncHive error?

Retrieve a Complete Documentation Page​

Your AI application may initially use only the section of a page that is most relevant to your question.

If you need the complete content, ask it to retrieve the full documentation page.

Open the Original Documentation​

Documentation results include links to their original locations on docs.synchive.com.

Find Your Workspaces and Hives​

The MCP server can identify the Workspaces and Hives available to the signed-in user.

For example, you can ask:

  • Which Workspaces and Hives can I access?
  • How many Hives does Workspace X have?

The MCP server only returns Hives that your SyncHive user is permitted to access.

Explore a Hive's Schema​

The MCP server can retrieve a compact overview of a selected Hive's current schema.

The overview identifies the entities, tables and shapes currently published in that Hive. It includes the exact table identifiers and shape names needed to retrieve their definitions.

For example, you can ask:

  • What entities, tables and shapes are in My Hive?
  • Give me an overview of My Hive's schema

In this context, current schema means the entities, tables and shapes currently published in the Hive. Draft and unpublished changes are not included.

Retrieve Table and Shape Definitions​

The MCP server can retrieve the definition of a table or a shape in the selected Hive's current schema, including:

  • the table's or shape's name and description
  • its parent entity
  • its properties and their configurations

The AI application first checks the selected Hive's schema overview to identify the correct table or shape.

For example, you can ask:

  • What properties are in the Product table in My Hive?
  • Show me the complete definition of the Country shape in My Hive
  • What data types are used by the properties in this table?
  • Which properties are required?
  • How is this shape structured?

Explore the Schema Library​

The MCP server can retrieve the Schema Library from the perspective of a selected Hive.

The result includes Library entities, tables and shapes and indicates whether each one is included in that Hive's current schema.

Use this capability to discover schema content that may help with your data model.

For example, you can ask:

  • Does the Schema Library contain a Product entity?
  • What properties are available in the UnitOfMeasure table?
  • Which Library tables could help me design an inventory schema?
  • Is Product currently included in My Hive?
  • Which Library items are not yet included in My Hive?

Work With Table Data​

The MCP server can identify the properties that can be queried for a selected table and the filter operations supported by each property.

It can also retrieve and filter records from that table using supported SyncHive filter syntax.

For example, you can ask:

  • Which properties can I query in the Product table in My Hive?
  • Which filter operations can I use with the status property?
  • Find Product records where the name contains "Toaster"

Create and Change a Hive's Schema​

If you have the required permissions, you can use the MCP server to:

  • create, update or delete an entity
  • create a table, optionally including its properties
  • update a table or its properties
  • delete a table
  • create, update or delete table properties

For example, you can ask:

  • Create a Project entity in My Hive
  • Add a Task table to the Project entity in My Hive
  • Add a mandatory email property to the Customer table

Use Schema Information for an App Design​

You can ask your AI application to use the selected Hive's schema when explaining or designing an application.

Schema-based answers and designs preserve the names, data types, hierarchy and relationships defined in SyncHive.

For example, you can ask:

  • Create a data model diagram for My Hive
  • Design a form for creating records in the Customer table
  • Generate an example record that follows the Product shape

Create a SyncHive App Registration​

The MCP server can create an app registration in a selected Hive.

To create a registration, specify:

  • the target Hive
  • a registration name
  • one or more shapes from that Hive

For example, you can ask:

  • Create an app registration called Inventory App in My Hive using the Product and UnitOfMeasure shapes

Retrieve an App Registration Prompt​

After creating an app registration, you can ask the MCP server to retrieve its generated connection prompt.

The prompt contains:

  • the registration's publishable key
  • its assigned shapes and their definitions
  • instructions for connecting an application to SyncHive
  • links to relevant SyncHive documentation

You can provide this prompt to an AI app-building tool so it can connect the application it generates to the selected Hive.