🚀 Quick Start
Configure your MCP client with the following settings to get started:
{
"mcpServers": {
"Compoid": {
"url": "https://mcpv.compoid.com/mcp",
"disabled": false,
"transportType": "streamable-http",
"headers": {
"X-Compoid-Repo-Key": "Repository-Compoid-Free-Subscription-API-Key"
}
}
}
}
Or install locally via pip: https://gitlab.com/compoid-ai/compoid-mcp.git
The Repository Structure
The repository isn't just a folder tree; it’s a hierarchy designed for both
human navigation and machine readability.
Communities & Collection:
Communities: These serve as the top-level nodes (e.g., "Engineering," "Marketing," or "Legal"). They define the ownership and the high-level context of the data.
Collections: Within each community, data is further grouped into specific projects or document types. This allows for granular permissions and targeted searching.
Metadata: The Digital DNA:
Metadata is what allows an LLM to "understand" a file without necessarily reading the whole thing. It usually includes:
Descriptive: Title, author, keywords, and abstract.
Technical: File format, size, and checksums.
Administrative: License info, retention dates, and version history.
The Bridge: How the LLM Interacts with the Data
The Model Context Protocol (MCP) is the secret sauce. It acts as a standardized "translator" between the LLM and your repository.
When you use an MCP server like compoid-mcp, you are giving the LLM a set of tools it can use to interact with your data.
Instead of just "chatting," the AI can now execute specific functions inside the repository.
Through the compoid-mcp connection, the LLM performs four primary actions:
Search Records: The LLM doesn't just do a keyword match. Because it understands the Metadata, it can perform complex queries.
Create Records: If you provide a raw document, the AI can summarize it, suggest relevant keywords (metadata), assign it to a Community, and call a function to create a new entry in the repository database.
Download Artifacts: The MCP connection allows the LLM to provide you with direct links or stream the content of a file. It identifies the correct "artifact" (the actual file) associated with a metadata record and retrieves it for your use.
Upload Artifacts: The LLM utilizes the compoid-mcp connection to programmatically upload files into specific communities while automatically generating and attaching the metadata necessary for instant searchability and organization.