Xano MCP Server H9l

🚀 Xano MCP Server

An implementation of the Model Context Protocol (MCP) server for interfacing with the Xano API. This server provides tools and resources to manage Xano database operations via the MCP interface.

🚀 Quick Start

This Xano MCP Server offers a comprehensive solution for interacting with the Xano API. It provides a set of tools and resources to manage Xano database operations through the MCP interface.

✨ Features

• Secure authentication using the Xano API.
• Type-safe API interactions based on TypeScript.
• Configuration via environment variables.
• Interfaces compliant with the MCP standard.
• Workspace management tools.
• Table content operations (create, read, update).
• Improved error handling with detailed messages.

📦 Installation

# Clone the repository
git clone [your-repo-url]
cd xano_mcp

# Install dependencies
npm install

🛠️ Configuration

1. Copy the example environment file:

cp .env.example .env

2. Update the .env file with your Xano credentials:

XANO_API_KEY=your_api_key_here
XANO_API_URL=your_xano_api_url
NODE_ENV=development
API_TIMEOUT=10000

💻 Usage Examples

Basic Usage

# Build the project
npm run build

# Run in development mode
npm run dev

# Start the server
npm start

Advanced Usage

The project structure is organized as follows:

xano_mcp/
├── src/
│   ├── api/
│   │   └── xano/
│   │       ├── client/       # API client implementation
│   │       ├── models/       # Data models and types
│   │       ├── services/     # API service implementation
│   │       └── utils/        # Utility functions
│   ├── mcp/
│   │   ├── server/          # MCP server implementation
│   │   ├── tools/           # MCP tool implementation
│   │   └── types/           # Tool-specific types
│   ├── config.ts            # Configuration management
│   └── index.ts             # Entry file
├── .env                     # Environment variable file
├── .env.example            # Example environment variables
└── package.json            # Project dependencies and scripts

Available Tools

• Workspace Creation: Create a new workspace using createWorkSpace.

const result = await createWorkSpace({
  name: "test", // Workspace name
  description: "Test workspace" // Workspace description
});

• Table Creation: Create a new table in a specified workspace using createTable.

const result = await createTable(wspId, {
  name: "users", // Table name
  columns: ["id", "name", "email"] // Table columns
});

• Data Insertion: Insert data into a specified table using insertData.

const result = await insertData(wspId, tableId, {
  data: [
    { id: 1, name: "Alice", email: "alice@example.com" },
    { id: 2, name: "Bob", email: "bob@example.com" }
  ]
});

📚 Documentation

Environment Variables

Error Handling

The server provides detailed error messages, including:

• Invalid parameters
• Authentication failure
• API request failure
• Content validation errors
• Unknown tool requests

Security

• Store sensitive configurations using environment variables.
• Integrate TruffleHog to prevent secret leaks.
• API keys and sensitive data are never committed to the code repository.

Contribution Guidelines

1. Create a feature branch.
2. Make your changes.
3. Submit a pull request.

📄 License

ISC