Skyvia MCP Fabrication Hub

A Model Context Protocol (MCP) adapter designed for seamless interaction with the Skyvia remote service endpoints, concentrating on data pipeline and synchronization functionalities.

Synopsis

This MCP nexus supplies utilities for communicating with the Skyvia API suite, empowering users to:

• Administer tenant workspaces
• Configure persistent data linkages
• Catalog, inspect, and initiate integration workflows
• And supplementary operations

The nexus is optimized for deployment within the Smithery environment to ensure accessible communication channels via secure WebSocket tunnels.

Utility Set

Workspace Management Tools

• list_workspaces: Fetch a comprehensive registry of all tenant workspaces.
• get_workspace: Retrieve granular specifications for a designated workspace.

Data Linkage Tools

• list_connections: Enumerate all configured data linkages within a specific workspace.
• get_connection_details: Obtain the specific configuration parameters for an existing linkage.
• test_connection: Validate the operational viability of a specified data linkage.

Workflow Orchestration Tools

• list_integrations: Produce a roster of defined workflows resident in a workspace.
• get_integration: Fetch the blueprint details for a particular workflow.
• run_integration: Trigger the immediate execution of a specified workflow process.

Deployment Instructions

Prerequisites Checklist

• A functional Docker environment on the local host machine.
• Authorized connectivity credentials for the Smithery deployment infrastructure.
• A valid, authenticated Skyvia API access token.

Local Validation Procedures

To validate the MCP adapter operation locally:

1. Install necessary prerequisites: pip install -r requirements.txt

2. Establish required environmental parameters: export SKYVIA_API_TOKEN="your-api-token-here"

3. Initiate the adapter service: python main.py

4. Engage with the service using an MCP inspection utility: npx @modelcontextprotocol/inspector python main.py

Smithery Deployment Protocol

1. Integrate the adapter service into the Smithery registry.
2. Provision the adapter with the necessary Skyvia authentication credentials.
3. Finalize deployment and verify functionality through the Smithery operational console.

Configuration Mandates

The adapter mandates the presence of a Skyvia API credential for authenticating requests against the Skyvia API. This credential must be supplied via the environment variable named SKYVIA_API_TOKEN.

Operational Examples

Illustrative examples of tool invocation:

Listing Available Workspaces

// Sample MCP client interaction script
const response = await client.useToolWithMCP("list_workspaces", {});
console.log(response);

Cataloging Defined Workflows

// Sample MCP client interaction script
const response = await client.useToolWithMCP("list_integrations", {
  workspace_id: 123 // Substitute with the actual workspace identifier
});
console.log(response);

Executing a Data Flow

// Sample MCP client interaction script
const response = await client.useToolWithMCP("run_integration", {
  workspace_id: 123, // Substitute with the actual workspace identifier
  integration_id: 456 // Substitute with the actual workflow identifier
});
console.log(response);

Debugging Guidance

"Adapter Uninitialized" Symptom

If the error "Adapter not initialized" surfaces during tool invocation, it typically points to a failure during the adapter's startup phase, often due to an absent or invalid API credential. Remedial steps:

1. Confirm the validity and requisite permissions associated with your Skyvia API credential.
2. Ensure the environment variable SKYVIA_API_TOKEN is correctly established:
3. For localized validation, employ export SKYVIA_API_TOKEN="your-token-here"
4. For Smithery deployments, confirm the token is correctly provisioned within your Smithery configuration profile

Resolving Linkage Connectivity Issues

The repository contains a specialized diagnostic routine for connectivity validation:

# Set the necessary API credential
export SKYVIA_API_TOKEN="your-token-here"

# Optionally set the Smithery access key (if distinct from default)
export SMITHERY_API_KEY="your-smithery-api-key"

# Execute the diagnostic routine
python test_smithery_connection.py

This routine will perform the following actions: - Validate direct communication with a locally hosted adapter instance. - Validate communication with the adapter deployed via Smithery. - Deliver comprehensive log outputs and troubleshooting suggestions. - Correlate results to pinpoint whether the failure originates from Smithery configuration or the adapter service itself.

Frequent Pitfalls

1. Dependency Gaps: Verify that all required packages have been installed using pip install -r requirements.txt.
2. Stale API Credential: The access token might be expired or lack the necessary authorization scopes.
3. Smithery Profile Malfunction: If utilizing Smithery, verify that the associated profile settings correctly incorporate the API token.
4. Network Obstructions: If operating behind a secure corporate network, confirm that outbound WebSocket communication channels are permitted.

Contributions

Submissions are encouraged! Kindly submit any proposed enhancements via a Pull Request.

Licensing

MIT