mcp-compass-nfc-v2
v1.1.26
Published
A Model Context Protocol (MCP) server implementation for NFC-related operations and product management with Shopify integration
Downloads
142
Maintainers
Readme
MCP Compass NFC Server
A Model Context Protocol (MCP) server implementation for NFC-related operations and product management with Shopify integration.
Overview
This MCP server provides tools for managing NFC-enabled products, user collections, and integration with Shopify storefront. It handles product data management, user information retrieval, and NFC code operations.
Available Tools
1. Get User Information
Tool ID: get_user_information
Retrieves customer/user data using email address and returns associated product collections.
Parameters:
email(string): User's email address
Returns: User information including first name, last name, phone number, and product collections.
2. Add New Unique Code
Tool ID: add_new_unique_code
Adds a new unique code to the database for product identification.
Parameters:
unique_code(string): Unique identifier for the product
Returns: Confirmation message when unique code is successfully added.
3. Add Product Data
Tool ID: add_product_data
Adds new product data to the database with Shopify integration. The unique parameter is the Shopify slug.
Parameters:
uturn_title(string, required): Product title for Uturn systemshopify_slug(string, required): Shopify product handle/slugshopify_title(string): Product title from Shopifycolor(string, required): Product colorsku(string): Product SKU
Returns: Success confirmation with product data.
4. Add User Product Collection
Tool ID: add_user_product_collection
Creates a product collection for a user, linking NFC codes with products and customers.
Parameters:
slug(string): Product slug from Shopifyunique_code(string): Unique code for the productemail(string): User's email addressnfc_code(string): NFC code for the product
Returns: Success confirmation with product details and ownership information.
5. Get Uturn Information
Tool ID: get_uturn_information
Retrieves information from Uturn API using NFC code.
Parameters:
nfc(string, required): NFC code to query
Returns: Data from Uturn API based on the provided NFC code.
6. Unpair Product Collection
Tool ID: unpair_product_collection
Removes a product collection from a user's account and unpairs the unique code.
Parameters:
unique_code(string, required): Unique code of the collection to unpair
Returns: Confirmation message when collection is successfully unpaired.
Note: When calling this tool, do not call other tools simultaneously.
Installation
npm install -g mcp-compass-nfc-v2Environment Variables
Create a .env file with the following variables:
ATLAS_NAME=your_atlas_username
ATLAS_ADDRESS=your_atlas_cluster_address
ATLAS_COLLECTION=your_atlas_collection_name
SHOPIFY_STORE_DOMAIN=your-shopify-store.myshopify.com
SHOPIFY_API_VERSION=2024-01
SHOPIFY_STOREFRONT_ACCESSTOKEN=your_shopify_storefront_access_token
UTURN_API=your_uturn_api_url
AI_MODEL=gpt-4o-miniMCP Server Configuration
Add this to your MCP client configuration:
{
"mcpServers": {
"mcp-compass-nfc-v2": {
"command": "npx",
"args": ["mcp-compass-nfc-v2"],
"env": {
"ATLAS_NAME": "your_atlas_username",
"ATLAS_ADDRESS": "your_atlas_cluster_address",
"ATLAS_COLLECTION": "your_atlas_collection_name",
"SHOPIFY_STORE_DOMAIN": "your-shopify-store.myshopify.com",
"SHOPIFY_API_VERSION": "2024-01",
"SHOPIFY_STOREFRONT_ACCESSTOKEN": "your_shopify_storefront_access_token",
"UTURN_API": "your_uturn_api_url",
"AI_MODEL": "gpt-4o-mini"
}
}
}
}Usage
Start the server
mcp-compass-nfcFeatures
- NFC Code Management: Add and manage unique NFC codes for products
- Product Data Management: Store and retrieve product information with Shopify integration
- User Collection Management: Link users with their product collections
- Uturn API Integration: Fetch additional product information from Uturn
- Collection Unpairing: Remove product collections from user accounts
- MongoDB Integration: Persistent data storage with Mongoose ODM
License
ISC
