Chroma MCP Server

🚀 色度（Chroma）項目

色度（Chroma）是一個用於創建持久、可搜索的“工作記憶”的工具，能有效輔助 AI 開發工作流程。該服務器配備了專門工具，藉助嵌入式技術管理跨會話的上下文。

🚀 快速開始

若你想快速上手色度（Chroma）項目，可參考後續的安裝和使用說明。

📦 安裝指南

使用 Hatch 工具安裝

要使用 hatch 工具安裝 Chroma 項目，請執行以下命令：

pip install hatch
cd path/to/chroma-project
hatch install --dev

更多信息請參考 Hatch 文檔。

使用 Uv 工具安裝

要使用 uv 工具從 PyPI 安裝 Chroma 項目，請執行以下命令：

uvx install chroma-mcp-server

更多信息請參考 Uv 文檔。

💻 使用示例

基礎用法

運行服務器

要運行 Chroma 服務器，請使用以下命令：

hatch run chroma-mcp-server start -- --config path/to/config.yaml

或者直接從 PyPI 安裝的版本運行：

chroma-mcp-server start -- --config path/to/config.yaml

更多信息請參考 快速入門指南。

📚 詳細文檔

集成指南

與 Cursor 的集成

要在項目中集成 Chroma，請在項目根目錄下創建或修改 .cursor/mcp.json 文件。以下是配置示例：

{
  "mcpServers": {
    "chroma_dev": {
      "command": "/path/to/project/scripts/run_chroma_mcp_server_dev.sh",
      "args": [],
      "env": {
        "CHROMA_CLIENT_TYPE": "persistent",
        "CHROMA_DATA_DIR": "/path/to/your/dev_data",
        "CHROMA_LOG_DIR": "/path/to/your/dev_logs",
        "LOG_LEVEL": "DEBUG",
        "MCP_LOG_LEVEL": "DEBUG"
      }
    },
    "chroma_test": {
      "command": "uvx",
      "args": [
        "--refresh",
        "--default-index", "https://test.pypi.org/simple/",
        "--index", "https://pypi.org/simple/",
        "--index-strategy", "unsafe-best-match",
        "chroma-mcp-server@latest"
      ],
      "env": {
        "CHROMA_CLIENT_TYPE": "persistent",
        "CHROMA_DATA_DIR": "/path/to/your/test_data",
        "CHROMA_LOG_DIR": "/path/to/your/test_logs",
        "LOG_LEVEL": "INFO",
        "MCP_LOG_LEVEL": "INFO"
      }
    },
    "chroma_prod": {
      "command": "uvx",
      "args": [
        "chroma-mcp-server"
      ],
      "env": {
        "CHROMA_CLIENT_TYPE": "persistent",
        "CHROMA_DATA_DIR": "/path/to/your/prod_data",
        "CHROMA_LOG_DIR": "/path/to/your/prod_logs",
        "LOG_LEVEL": "INFO",
        "MCP_LOG_LEVEL": "INFO"
      }
    }
  }
}

更多信息請參考 集成指南。

開發流程

要參與開發，請執行以下命令：

git clone git@github.com:your-username/chroma-project.git
cd chroma-project
pip install -r requirements/development.txt
hatch run pytest tests/

更多信息請參考 開發者文檔。

✨ 主要特性

項目背景

動機

為了應對 AI 開發工作流程中的挑戰，我們開發了 Chroma。通過結合現代存儲技術與分佈式系統設計，Chroma 能夠高效管理大規模數據。

核心功能

• 持久化存儲：確保數據在會話之間保持可用。
• 可擴展性：支持高併發訪問和大數據量處理。
• 集成能力：兼容多種工具和服務的工作流程。

更多信息請參考 設計文檔。

📄 相關鏈接

• 項目倉庫地址：https://github.com/your-username/chroma-project
• 在線文檔：https://your-docs-site.chroma-project.org

🤝 貢獻指南

歡迎社區貢獻！請參考 開發者文檔 瞭解如何參與開發。

⚠️ 重要提示

此文檔為示例，實際項目應根據具體需求進行調整。