Context Portal MCP (ConPort) 项目启动与配置教程

1. 项目目录结构及介绍

Context Portal (ConPort) 项目的主要目录结构如下：

context-portal/
├── .github/                # GitHub 工作流和配置文件
├── assets/                 # 静态资源文件，如图片等
├── conport-custom-instructions/ # 自定义指令相关文件
├── src/                    # 源代码目录
│   └── context_portal_mcp/ # Context Portal MCP 服务器代码
├── .gitignore              # Git 忽略文件列表
├── LICENSE                 # 项目许可证文件
├── README.md               # 项目说明文件
├── SECURITY.md             # 项目安全策略文件
├── conport_mcp_deep_dive.md # Context Portal MCP 深入探讨文档
└── pyproject.toml          # 项目配置文件

每个目录和文件的功能简要介绍如下：

• .github/：包含 GitHub 工作流和配置文件，用于自动化项目的一些操作。
• assets/：存放项目的静态资源，如文档中的图片等。
• conport-custom-instructions/：包含自定义指令相关文件，用于扩展 Context Portal 的功能。
• src/：源代码目录，包含项目的主要逻辑。
• .gitignore：定义了 Git 忽略的文件和目录列表，以避免将不必要的文件提交到版本库。
• LICENSE：项目的许可证文件，本项目采用 Apache-2.0 许可。
• README.md：项目的说明文档，介绍了项目的基本信息和如何使用。
• SECURITY.md：项目安全策略文件，提供了项目安全相关的信息和指南。
• conport_mcp_deep_dive.md：深入探讨 Context Portal MCP 的文档，包含更详细的技术信息。
• pyproject.toml：项目的配置文件，定义了项目的元数据和依赖。

2. 项目的启动文件介绍

项目的启动主要通过 src/context_portal_mcp 目录下的 Python 脚本进行。以下是启动 Context Portal MCP 服务器的基本命令：

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

其中：

• context_portal_mcp.main 是 Context Portal MCP 服务器的主模块。
• --mode stdio 指定服务器以标准输入输出模式运行，通常用于 IDE 集成。
• --workspace_id 指定项目的工作空间 ID，通常是项目目录的绝对路径。

3. 项目的配置文件介绍

项目的配置主要通过 pyproject.toml 文件进行。该文件采用了 TOML 格式，包含了项目的元数据和依赖信息。以下是一个示例配置：

[tool.poetry]
name = "context-portal-mcp"
version = "0.1.0"
description = "A database-backed Model Context Protocol (MCP) server for managing structured project context."
authors = ["GreatScottyMac"]

[tool.poetry.dependencies]
python = "^3.8"

[tool.poetry.dev-dependencies]
uvicorn = "^0.15.0"
pytest = "^6.2.4"

在这个配置文件中，定义了项目名称、版本、描述、作者以及项目依赖的 Python 版本和其他依赖项。

要启动项目，首先确保已经创建并激活了虚拟环境，然后通过以下命令安装项目依赖：

pip install -r requirements.txt

安装完成后，就可以使用前面提到的命令启动 Context Portal MCP 服务器了。