Getting started
Integration Guide
MCP API
When to use: Choose the MCP API when you need direct HTTP access to GWI data from your backend services, or any application that can make HTTP requests. This is the best choice for:
- Production applications and services
- Server-side integrations
- Custom scripts and tools
Request example:
Response example:
MCP Remote
When to use: Choose the MCP remote when your MCP client needs to connect to a local server. This is typically required for:
- Desktop MCP clients that connect to local servers
- MCP clients that don’t support direct HTTP endpoints
- Development and testing of MCP integrations
The MCP remote is an npm package that runs locally on your machine and acts as a bridge between MCP clients and the Spark API. This is available on:
- GitHub: mcp-remote
- NPM: mcp-remote
How to use:
-
Install Node.js for accessing
npx
on your machine. Please use one of the following methods to install for your OS:- using package managers (macOs, windows)
- using the installers from the official nodejs download page
-
Validate
npx
exists in your system -
Use the following configuration for your MCP client: