context-portal 的安装和配置教程

项目基础介绍

context-portal 是一个开源项目，旨在构建一个项目特定的知识图谱，以帮助 AI 助手更好地理解特定的软件项目。它通过存储项目中的重要信息，如决策、任务和架构模式，以结构化的方式，使得 AI 可以快速访问和使用这些信息，提供更准确和有用的响应。

该项目主要使用 Python 编程语言。

项目使用的关键技术和框架

context-portal 使用以下关键技术和框架：

• SQLite：作为数据库后端，存储和管理项目上下文信息。
• Python/FastAPI：构建 MCP 服务器，用于处理和响应客户端请求。
• 向量嵌入：用于语义搜索，提高信息检索的准确性。
• Retrieval Augmented Generation (RAG)：结合检索和生成，提高 AI 响应的上下文相关性。

项目安装和配置准备工作

在开始安装 context-portal 之前，请确保您的系统已满足以下要求：

• Python 3.8 或更高版本。
• 推荐使用 uv 作为 Python 环境和包管理器，但也可以使用标准的 Python venv 和 pip。
• 克隆项目仓库到本地。

git clone https://github.com/GreatScottyMac/context-portal.git
cd context-portal

安装步骤

使用 PyPI 安装

1. 创建并激活虚拟环境：

使用 uv（推荐）：

uv venv
source .venv/bin/activate  # Linux/macOS
.venv\Scripts\activate.bat  # Windows (Command Prompt)
.venv\Scripts\Activate.ps1  # Windows (PowerShell)

使用标准 venv（如果不使用 uv）：

python3 -m venv .venv
source .venv/bin/activate  # Linux/macOS
.venv\Scripts\activate.bat  # Windows (Command Prompt)
.venv\Scripts\Activate.ps1  # Windows (PowerShell)

2. 安装 context-portal：

使用 uv：

uv pip install context-portal-mcp

使用标准 pip：

pip install context-portal-mcp

3. 配置 MCP 服务器：

将以下配置代码中的路径替换为您的虚拟环境中 Python 执行文件的绝对路径，并保存为配置文件（例如 config.json）。

{
  "mcpServers": {
    "conport": {
      "command": "/path/to/your/.venv/bin/python",
      "args": ["-m", "context_portal_mcp.main", "--mode", "stdio", "--workspace_id", "${workspaceFolder}"]
    }
  }
}

4. 运行服务器：

conport-mcp --mode stdio --workspace_id "/path/to/your/project_workspace"

从 Git 仓库安装

1. 克隆项目仓库：

git clone https://github.com/GreatScottyMac/context-portal.git
cd context-portal

2. 创建并激活虚拟环境，然后安装项目依赖：

# 使用 uv
uv venv
source .venv/bin/activate  # Linux/macOS
.venv\Scripts\activate.bat  # Windows (Command Prompt)
.venv\Scripts\Activate.ps1  # Windows (PowerShell)

# 使用 pip
pip install -r requirements.txt

3. 运行服务器：

python -m context_portal_mcp.main --mode stdio --workspace_id "/path/to/your/project_workspace"

确保将 "/path/to/your/project_workspace" 替换为您实际的项目工作区路径。

完成以上步骤后，您应该能够成功安装和配置 context-portal 项目。