Skip to main content

MCP server for FlockX AI agent platform - enables AI assistants to interact with FlockX agents

Project description

FlockX Logo
FlockX MCP Server

FlockX MCP Server

Legendary AI Agent Creation & Knowledge Ingestion for Cursor and Claude Desktop and so, so, so much more


🚀 Overview

This repository provides a Model Context Protocol (MCP) server for FlockX, enabling you to manage, train, and validate AI agents through a seamless conversational interface—right inside your development environment (Cursor) or Claude Desktop. With simple Markdown processes and best-practice templates, you can automate agent creation, knowledge ingestion, and validation with ease.


🛠️ Installation & Setup

Prerequisites

  • Python 3.7+
  • pip
  • FlockX API key

1. Clone & Install

git clone <repository-url>
cd mcp-server-flockx
python -m venv .venv
source .venv/bin/activate  # On Unix/macOS
# or
.venv\Scripts\activate  # On Windows
pip install -r requirements.txt

2. Configure Your API Key

Create a .env file in the project root:

FLOCKX_API_KEY=your_api_key_here

🖥️ Integrate with Cursor IDE

  1. Open (or create) .cursor/mcp.json in your project root, or ~/.cursor/mcp.json for global config.
  2. Add your MCP server config:
{
  "mcpServers": {
    "flockx-mcp": {
      "command": "/absolute/path/to/.venv/bin/python",
      "args": ["/absolute/path/to/run.py"],
      "env": {
        "FLOCKX_API_KEY": "your_api_key_here"
      }
    }
  }
}
  1. Restart Cursor. Your FlockX MCP tools will appear in the tools panel.

💬 Integrate with Claude Desktop

  1. Open Claude Desktop → Settings → Developer → Edit Config.
  2. Add to claude_desktop_config.json:
{
  "mcpServers": {
    "flockx-mcp": {
      "command": "/absolute/path/to/.venv/bin/python",
      "args": ["/absolute/path/to/run.py"],
      "env": {
        "FLOCKX_API_KEY": "your_api_key_here"
      }
    }
  }
}
  1. Save and restart Claude Desktop. Look for the MCP tools icon in chat.

🤖 Why Use the flockx MCP Server?

Working with the flockx MCP server in Cursor or Claude Desktop unlocks a new paradigm:

  • Conversational Training: Interact with your agent, teach new skills, and ingest knowledge—all through natural language.
  • Process Automation: Define and run complex workflows using simple Markdown files in training/processes/. No code required—just describe your process, and let your AI do the rest.
  • Best Practice Templates: Use the provided templates in training/templates/ to ensure every knowledge document and agent profile is structured for success.

You can iteratively build, test, and refine your agents in a collaborative, conversational loop—directly in your favorite environment.

🧪 What This Workflow Does For You

When you follow this workflow, the system will:

  • Create test agents in your FlockX account automatically.
  • Train each agent on your provided profession or domain knowledge (using your input files and best-practice extraction).
  • Enable you to ask any of your agents questions—directly in Cursor or Claude Desktop—so you can interact, test, and validate their knowledge in real time.

This makes it easy to prototype, experiment, and iterate on agent skills and knowledge before deploying to production.


🚀 Full Workflow Overview

See how much gets done with a single command:

flowchart TD
  subgraph "Extract Skills Knowledge Local"
    A[List Inputs] --> B[Read Input File]
    B --> C{Extract Skills}
    C --> D[Fill Knowledge Template]
    D --> E[Save Knowledge Doc]
  end

  subgraph "Generate Agent Profiles Local"
    F[List Knowledge Docs] --> G[Read Knowledge Doc]
    G --> H{Extract Agent Info}
    H --> I[Fill Agent Template]
    I --> J[Save Agent Profile]
  end

  subgraph "Create Agents FlockX API"
    K[Create Agent API]
  end

  subgraph "Upload Knowledge FlockX API"
    L[Upload Knowledge Doc API]
  end

  subgraph "Validate Completion FlockX API"
    M[Query FlockX API]
  end

  E --> F
  J --> K
  E --> L
  K --> M
  L --> M

  classDef api_node fill:#e0e7ff,stroke:#6366f1,stroke-width:2px;
  class K,L,M api_node

📝 Next Steps: Orchestrate the Full Workflow

To get started with end-to-end agent creation and knowledge ingestion, simply ask your AI assistant (in Cursor or Claude Desktop):

"Please follow the instructions in training/processes/process-overall-agent-knowledge-ingestion.md to extract, generate, upload, and validate agent knowledge."

Your AI will guide you through each step, leveraging the Markdown processes and templates provided.


🛠️ Troubleshooting

  • FLOCKX_API_KEY not set: Ensure you have created a .env file in the project root with your FLOCKX_API_KEY from FlockX.io.
  • MCP server not responding: Verify run.py is executing in stdio mode via your IDE/terminal.
  • Rate limiting: If you encounter API rate limits, consider adjusting your workflow or contacting FlockX support.

🤝 Contributing

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mcp_server_flockx-0.1.0.tar.gz (6.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

mcp_server_flockx-0.1.0-py3-none-any.whl (6.3 kB view details)

Uploaded Python 3

File details

Details for the file mcp_server_flockx-0.1.0.tar.gz.

File metadata

  • Download URL: mcp_server_flockx-0.1.0.tar.gz
  • Upload date:
  • Size: 6.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.5

File hashes

Hashes for mcp_server_flockx-0.1.0.tar.gz
Algorithm Hash digest
SHA256 53d5963a85583c75e1c8f9fbb3636559795bfcaaeaa65f549277bd5986b4ad30
MD5 95f309133b1e573aa57891c2b585780b
BLAKE2b-256 e12ae1d590cffa70d4b31277c5a2b0ecd9e8efe9b597ccc718e57990452162a1

See more details on using hashes here.

File details

Details for the file mcp_server_flockx-0.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for mcp_server_flockx-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 30fc4cf75ffe73b74958405e0ccc9b88b2227c26b4d17e757600ecb6620b1867
MD5 dec1a1696de3729ceb938d907bf7bc4b
BLAKE2b-256 4477ee646f9f666f3de2440c4f1333807a2c56ef98bbf2fed81a7e3db117a2b7

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page