- Home
- MCP servers
- Square
Square
- java
1
GitHub Stars
java
Language
6 months ago
First Indexed
2 months ago
Catalog Refreshed
Documentation & install
Readme and setup notes from the catalogue, plus a client-ready config you can copy for your MCP host.
Installation
Add the following to your MCP client configuration file.
Configuration
View docs{
"mcpServers": {
"cdatasoftware-square-mcp-server-by-cdata": {
"command": "java",
"args": [
"-jar",
"/PATH/TO/CDataMCP-jar-with-dependencies.jar",
"/PATH/TO/square.prp"
]
}
}
}You have a local, read-only MCP server that exposes live Square data to large language models via a simple MCP interface. It wraps the CData JDBC Driver for Square so you can query data in natural language without writing SQL, while keeping data access secure and read-only on your machine.
How to use
You connect to this MCP server from an ML client or tool that supports MCP by adding a local MCP server entry. The server exposes tools that let you discover available data and run read queries, so you can ask questions like what opportunities are open or how many tickets are in a project. You don’t need to craft SQL; you simply request information in natural language and the client translates it into tool calls.
How to install
Prerequisites you need before you begin:
-
Java Runtime Environment (JRE) or JDK for running the MCP server jar.
-
Maven for building the MCP server package.
-
A JDBC driver for Square (CData JDBC Driver for Square) to enable live data access.
Follow these steps to set up and run the server locally:
- Clone the project repository and enter the directory.
git clone https://github.com/cdatasoftware/square-mcp-server-by-cdata.git
cd square-mcp-server-by-cdata
Install the CData JDBC Driver for Square
Download and install the CData JDBC Driver for Square from the official source.
https://www.cdata.com/drivers/square/download/jdbc
License the JDBC Driver
License the driver using the jar in your installation and provide your details when prompted.
java -jar cdata.jdbc.square.jar --license
Configure the connection to your data source
Run the Connection String utility to configure how the driver connects to Square. You will test the connection and copy the resulting JDBC URL for use in your server configuration.
java -jar cdata.jdbc.square.jar
Create the JDBC properties file
Create a .prp file that defines the MCP server connection to the data source. This file includes a prefix, server name, version, the driver path, the driver class, and the JDBC URL you obtained earlier.
Prefix=square
ServerName=CDataSquare
ServerVersion=1.0
DriverPath=PATH\\TO\\cdata.jdbc.square.jar
DriverClass=cdata.jdbc.square.SquareDriver
JdbcUrl=jdbc:square:InitiateOAuth=GETANDREFRESH;
Tables=
Build the MCP server JAR
Build the MCP server package to produce the runnable JAR that exposes the MCP interface.
mvn clean install
Run the MCP server locally
Start the MCP server using the generated JAR and your .prp file. The server runs on stdio and is meant for local, single-machine use.
java -jar /PATH/TO/CDataMCP-jar-with-dependencies.jar /PATH/TO/square.prp
Configure your MCP client
Add the MCP server to your client configuration. The server is ready to respond to read-only queries once the client recognizes the local stdio server.
Available tools
square_get_tables
Retrieves a list of tables (data sources) available in Square through the MCP server. Output is in CSV format with column headers.
square_get_columns
Retrieves a list of columns for a specified table. Output is in CSV format with column headers.
square_run_query
Executes a SQL SELECT query against the Square data exposed by the MCP server and returns results.