MCP server for FlockX AI agent platform - enables AI assistants to interact with FlockX agents
Project description
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.8+
- FlockX API key (get one at agents.flockx.io)
Quick Install (Recommended)
# Install from PyPI
pip install mcp-server-flockx
# Or use uvx for isolated execution (preferred for MCP)
uvx mcp-server-flockx
# Or use pipx for global installation
pipx install mcp-server-flockx
Alternative: Install from Source
git clone https://github.com/flockx-official/mcp-server-flockx
cd mcp-server-flockx
pip install -e .
🖥️ Integrate with Cursor IDE
- Open Cursor Settings (Cmd+, or Ctrl+,)
- Search for "MCP" or navigate to MCP settings
- Add to your MCP configuration:
{
"mcpServers": {
"flockx-mcp": {
"command": "uvx",
"args": ["mcp-server-flockx"],
"env": {
"FLOCKX_API_KEY": "your_api_key_here"
}
}
}
}
- Restart Cursor
- Enable Agent Mode in your chat (critical!)
- Your FlockX MCP tools will appear in the tools panel
💬 Integrate with Claude Desktop
- Open Claude Desktop → Settings → Developer → Edit Config
- Add to
claude_desktop_config.json:
{
"mcpServers": {
"flockx-mcp": {
"command": "uvx",
"args": ["mcp-server-flockx"],
"env": {
"FLOCKX_API_KEY": "your_api_key_here"
}
}
}
}
- 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.mdto 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_KEYnot set: Add your API key to the MCP configuration in Cursor/Claude settings- MCP server not responding: Ensure you've restarted your IDE after configuration
- "Need approval" messages: Enable Agent Mode in Cursor (critical!)
- Installation issues: Try
pip install --upgrade mcp-server-flockx - Rate limiting: If you encounter API rate limits, consider adjusting your workflow or contacting FlockX support
📦 Releasing to PyPI (maintainers)
Semantic versioning is used: MAJOR.MINOR.PATCH.
- Update
pyproject.tomlandsrc/mcp_server_flockx/__init__.pywith the new version. - Update
CHANGELOG.md. - Create and push a tag to trigger publish (GitHub Actions):
git checkout main && git pull
git tag -a v0.2.0 -m "Release v0.2.0"
git push origin v0.2.0
CI will build and publish to PyPI when the tag is pushed. Configure repository secret PYPI_API_TOKEN with an API token from PyPI.
🤝 Contributing
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file mcp_server_flockx-0.2.0.tar.gz.
File metadata
- Download URL: mcp_server_flockx-0.2.0.tar.gz
- Upload date:
- Size: 6.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.12.11
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
d34e9a6620962d85c17bb5926faaa61cf8dfb62ac9d56d14352186a17af18053
|
|
| MD5 |
faa3116f8a9228d15dcfb8b49edd348d
|
|
| BLAKE2b-256 |
319d2545f9c12dad46163c6c5d3d2ec435026b4eda6a6271584f06a1563da9e3
|
File details
Details for the file mcp_server_flockx-0.2.0-py3-none-any.whl.
File metadata
- Download URL: mcp_server_flockx-0.2.0-py3-none-any.whl
- Upload date:
- Size: 6.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.12.11
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
123992827cacbee32ad4d716418616010e735d995f8312a8a47ffc6ec2694cf2
|
|
| MD5 |
693a0a898ca599f478916d607e99ea01
|
|
| BLAKE2b-256 |
8d4f8fcb1784fa3ed5e6fc3f0743785e3cb69dd90af13494fde5db342760b67c
|