MCP Server Integration
The Kumiho Python SDK includes a built-in Model Context Protocol (MCP) server that enables AI assistants like GitHub Copilot, Claude, and other MCP-compatible clients to interact with Kumiho Cloud directly.
What is MCP?
The Model Context Protocol is an open standard that allows AI assistants to connect to external data sources and tools. By exposing Kumiho’s functionality through MCP, AI assistants can:
Query and navigate your asset graphs
Analyze dependencies and impact of changes
Search for items across projects
Track AI lineage and provenance
Create, update, and manage revisions and artifacts
Build and manage bundles
Installation
Install the Kumiho SDK with MCP support:
pip install kumiho[mcp]
Or if you already have kumiho installed:
pip install mcp httpx
Authentication
Before running the MCP server, authenticate with Kumiho Cloud:
kumiho-auth login
This caches your credentials which the MCP server will use automatically.
Running the MCP Server
Standalone Mode
Run the MCP server directly:
kumiho-mcp
Or using Python module:
python -m kumiho.mcp_server
VS Code / GitHub Copilot Integration
Add the following to your VS Code settings.json:
{
"mcp": {
"servers": {
"kumiho": {
"command": "kumiho-mcp",
"args": []
}
}
}
}
Alternatively, if using a virtual environment:
{
"mcp": {
"servers": {
"kumiho": {
"command": "python",
"args": ["-m", "kumiho.mcp_server"],
"env": {
"PATH": "/path/to/your/venv/bin:${env:PATH}"
}
}
}
}
}
Claude Desktop Integration
Add to your Claude Desktop configuration (claude_desktop_config.json):
{
"mcpServers": {
"kumiho": {
"command": "kumiho-mcp"
}
}
}
Available Tools
The MCP server exposes 39 tools organized by category:
Read Operations (14 tools)
Tool |
Description |
|---|---|
|
List all accessible projects |
|
Get project details by name |
|
Get spaces within a project |
|
Get a space by path |
|
Get an item by kref URI |
|
Search items with filters |
|
Get all revisions for an item |
|
Get a revision by kref |
|
Get revision by tag (latest, published, etc.) |
|
Get all artifacts for a revision |
|
Get a single artifact by kref |
|
Get a bundle by kref |
|
Resolve kref to file location |
|
Reverse lookup artifacts by file path |
Graph Traversal (5 tools)
Tool |
Description |
|---|---|
|
Get what a revision depends on |
|
Get what depends on a revision |
|
Analyze downstream impact of changes |
|
Find shortest path between revisions |
|
Get edges (relationships) for a revision |
Create Operations (8 tools)
Tool |
Description |
|---|---|
|
Create a new project |
|
Create a space within a project |
|
Create an item within a space |
|
Create a new revision for an item |
|
Create an artifact for a revision |
|
Create a bundle to group items |
|
Create relationship between revisions |
|
Apply a tag to a revision |
Delete Operations (6 tools)
Tool |
Description |
|---|---|
|
Delete a project |
|
Delete a space |
|
Delete an item |
|
Delete a revision |
|
Delete an artifact |
|
Delete a relationship |
Update Operations (6 tools)
Tool |
Description |
|---|---|
|
Remove a tag from a revision |
|
Set metadata on item or revision |
|
Mark an item as deprecated |
|
Add an item to a bundle |
|
Remove an item from a bundle |
|
List all items in a bundle |
Example Conversations
Once configured, you can ask your AI assistant questions like:
Exploring Assets
“List all projects I have access to”
“What items are in the ‘characters’ space of project ‘film-2024’?”
“Show me all revisions for kref://film-2024/characters/hero.model”
Dependency Analysis
“What does the hero model depend on?”
“If I change this texture, what assets will be affected?”
“Find the path between the hero rig and the final render”
Asset Management
“Create a new revision for kref://film-2024/props/sword.model with metadata artist=’john’”
“Tag revision kref://film-2024/characters/hero.model?r=5 as ‘approved’”
“Add the hero model to the ‘main-characters’ bundle”
AI Lineage Tracking
“What training data was used to generate this AI asset?”
“Show me all assets derived from this base model”
Kref URI Format
Tools use Kref URIs to reference Kumiho objects:
kref://project/space/item.kind # Item
kref://project/space/item.kind?r=1 # Revision (r=revision number)
kref://project/space/item.kind?r=1&a=mesh # Artifact (a=artifact name)
Examples:
kref://film-2024/characters/hero.model- Hero model itemkref://film-2024/characters/hero.model?r=3- Revision 3kref://film-2024/characters/hero.model?r=3&a=mesh.fbx- Mesh artifact
Edge Types
When creating or querying edges, use these relationship types:
Edge Type |
Description |
|---|---|
|
Asset depends on another asset |
|
Asset was derived from another |
|
Asset references another |
|
Asset contains another |
|
AI asset created from training data |
|
Asset belongs to a bundle |
Environment Variables
Variable |
Description |
Default |
|---|---|---|
|
Log level (DEBUG, INFO, WARNING, ERROR) |
INFO |
MCP Resources and Prompts
The server also exposes:
Resources
Projects are exposed as MCP resources with URI format kumiho://project/{name}.
Prompts
Prompt |
Description |
|---|---|
|
Guided workflow to analyze an asset’s dependencies and impact |
|
Guided workflow to search for assets by kind and project |
Troubleshooting
Server won’t start
Ensure MCP dependencies are installed:
pip install kumiho[mcp]
Check authentication:
kumiho-auth statusEnable debug logging:
KUMIHO_MCP_LOG_LEVEL=DEBUG kumiho-mcp
Tools not appearing in AI assistant
Verify the MCP configuration in your settings
Restart your AI assistant/editor
Check the MCP server logs for connection errors
Authentication errors
Refresh your credentials:
kumiho-auth refresh
Or re-authenticate:
kumiho-auth login
API Reference
For detailed API documentation of the MCP server module, see the MCP Server API Reference.