Developer Guide

Item MCP supports importing API from Apifox, OpenAPI, and Swagger, which then can be automatically converted into MCP servers via Integrations that can be published as MCP Servers.

API Integration

Below is the flowchart:

Server Integration via item DI

The connector is exposed via the MCP protocol, with each API mapped to a tool. This allows AI agents to interact with it like any other MCP server.

┌────────────┐     API Call     ┌───────────────┐
│ MCP Server │ ───────────────► │   Item DI API │
│ (Tool: getOrder)              │ (GET /orders) │
└────────────┘                  └───────────────┘

  ↓                                ↑
Formatted as Tool           Appears as "Connector" in Item DI

Shopify Integration

This guide focus on how to configure and register an external API in Item DI, and convert it into an MCP-compatible server that can be used in Item MCP.

Prerequisites

• Item DI Login Account
• Shopify Client Credentials
• Shopify API

To obtain the Client ID and Client Secret from Shopify:

1. Log in to the Shopify Partner Portal (opens in a new tab).
2. Navigate to Apps > All apps > Create app.

3. Select Create app manually and give it a name.
4. Copy the Client ID and Client Secret for later use.

Step 1: Configure Basic Info

1. Log in to item DI (opens in a new tab).
2. Navigate to Integrations > Add New Integration.

3. Fill in the metadata for this integration:

4. Add the ShopDomain field in Common Parameters Schema.
5. Provide a field description in advanced settings to guide users.

6. Click Save and Next.

Step 2: Configure Authentication Method

1. Choose OAuth 2.0 Code as the authentication type.

2. Fill in the Client ID and Client Secret.
3. Under Build Auth URL, add:
   • grant_options[]
   • scope
4. Set token expiration values to -1 (indicates no expiration).

5. In the Code to Token tab, fill in:
   • Token URL
   • Access/Refresh Token Expiration: -1

6. Click Save and Next.

Step 3: Test the Configuration

1. Create a test API using the GET method.
2. Add the following header:
   • X-Shopify-Access-Token = ${accessToken}
3. Add an assert expression: httpCode == 200

4. Leave output type as Normal.
5. Click Save and Next.
6. Copy the Redirect URL from the Authentication tab.

7. In the Shopify App Dashboard, register this Redirect URL.

8. Click Save and Release in the Shopify developer portal.

Step 4: Create the Connector in Workspace

1. Go to Workspace, select a merchant, and click + Add Connector.

2. Choose the Shopify connector created earlier.

3. Enter the shop domain, e.g., iphone.myshopify.com.
4. Click Go to Verify to complete authentication.

5. After a successful redirect, the message "Connection successful" will appear.
6. Click Test Connection and submit.

7. The connector will now be listed under Connected Systems.

Step 5: View Logs

1. Go to Integrations > Connector.

2. Click View Logs to check connection and request history.

Step 6: Add Supported Features

1. Click Add New Feature.

2. Example: Add a "Query Location" feature.

3. Under JSON Schema Settings, define:
   • params.limit = ${params.limit}

4. Import an api.json configuration file.
5. In Output Processing, choose:
   • Output type: Path
   • JSONPath: $.data
6. Configure request headers, body, and query parameters.

7. Run a test — location information should be returned.

8. The feature will now appear under Supported Features.

Final Step: Test Servers

After completing the Shopify integration in Item DI, it is registered as a connector and can also be automatically published as an MCP server.

You can copy the SSE link and add it to any MCP-compatible client.