色度（Chroma）项目 README 文件

项目简介

色度 (Chroma) 是一个用于创建持久、可搜索的“工作记忆”以辅助 AI 开发工作流程的工具。该服务器包括专门的工具，利用嵌入式技术来管理跨会话的上下文。

安装说明

使用 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

贡献指南

欢迎社区贡献！请参考 开发者文档 了解如何参与开发。

注意：此文档为示例，实际项目应根据具体需求进行调整。