关键词

知识库C4模型架构文档上下文检索代码分析

项目简介

Melly是一个综合性的Claude Code组件集合，专注于智能上下文检索和知识管理。它提供插件、技能、代理和工作流，旨在增强Claude Code在代码库分析、技能开发和文档生成方面的能力。其核心组成部分之一是 'Basic Memory'，一个明确声明为基于Model Context Protocol (MCP) 的服务器，专门用于存储和管理C4模型（Context, Container, Component, Code）相关的架构文档。

主要功能点

  • MCP知识库服务: 'Basic Memory' 作为MCP服务器，提供标准化的知识存储和检索服务，支持LLM客户端获取上下文信息。
  • C4模型文档管理: 专门用于托管和管理软件架构的C4模型各层级（系统、容器、组件、代码）的详细文档。
  • 知识笔记操作: 允许用户创建、组织和高效搜索存储在知识库中的各类知识笔记和文档。
  • 多项目支持: 支持同时管理多个知识项目，有助于分离和组织不同代码库的架构信息。
  • 数据同步与持久链接: 提供数据同步机制，并支持生成持久链接，确保知识引用的稳定性和可追溯性。
  • Obsidian Canvas集成: 支持与Obsidian Canvas等可视化工具集成，以便更直观地展现和探索架构图谱。

安装步骤

Melly及其包含的Basic Memory插件是为Claude Code环境设计的本地插件。

  1. 克隆Melly仓库: 首先，您需要使用Git将Melly仓库克隆到您的本地机器。 
    git clone https://https://github.com/Cubical6/melly.git
cd melly
  2. 安装Basic Memory: Basic Memory MCP服务器的具体安装说明位于 'plugins/basic-memory' 目录下。请查阅该目录下的 'README' 文件或相关安装指南，以获取详细的安装和运行步骤。通常这会涉及运行一个脚本或构建一个可执行文件。
  3. 配置Claude Code: 在Claude Code开发环境中，您需要将 'basic-memory' 配置为一个MCP服务器。这通常在Claude Code的设置界面或配置文件中完成，以确保客户端能够发现并连接到Basic Memory服务。确保启用与知识库相关的Permalink和同步选项。

服务器配置

MCP客户端需要通过JSON-RPC协议连接到Basic Memory MCP服务器。以下是一个MCP客户端配置的示例结构，用户无需编写代码，只需在MCP客户端（如Claude Code）的配置界面中填入相应信息：

  • 'server_name': 'basic-memory'
    • 描述: 标识此MCP服务器的唯一名称。客户端将使用此名称来识别和连接到Basic Memory。
  • 'description': 'Melly项目的C4模型知识库MCP服务器'
    • 描述: 对服务器功能的简要描述，方便用户理解其用途。
  • 'command': '/path/to/melly/plugins/basic-memory/start_server.sh' (示例路径)
    • 描述: 启动Basic Memory MCP服务器的脚本或可执行文件的绝对路径。请根据您的实际安装位置进行替换。
  • 'args': '["--port", "8080", "--knowledge-base-path", "~/.basic-memory/knowledge-base"]' (示例参数)
    • 描述: 传递给服务器启动命令的参数列表。例如，'--port' 指定服务器监听的端口，'--knowledge-base-path' 指定知识库数据存储的根目录。具体的参数请参考 'plugins/basic-memory' 目录下的文档。
  • 'protocol': 'stdio'
    • 描述: MCP服务器与客户端之间通信所使用的传输协议，常见的包括'stdio' (标准输入输出)、'websocket' 或 'sse'。
  • 'capabilities': '{ "resources": ["read", "write", "search"], "tools": [], "prompts": [] }'
    • 描述: 声明此MCP服务器提供的能力。'Basic Memory' 主要提供对资源的读、写和搜索功能。

基本使用方法

一旦'Basic Memory' MCP服务器配置并运行，Melly的核心工作流就可以利用它进行知识管理：

  1. 初始化C4模型探索: 在Claude Code中运行 '/melly:init' 命令，Melly将扫描您的代码仓库结构并生成初始的 'init.json' 文件。
  2. 识别C1系统上下文: 运行 '/melly:c1-systems' 命令，Melly将检测系统边界并生成C1层级的架构文档。这些文档将通过运行中的 'Basic Memory' MCP服务器存储到指定的知识库中。
  3. C2/C3/C4层分析: 类似地，您可以继续运行 '/melly:c2-containers' 和 '/melly:c3-components' 命令，Melly将进一步分析代码的容器和组件层级，并将其文档存储到 'Basic Memory' 知识库。
  4. 生成文档与图表: 使用 '/melly:doc-c4model' 命令可以从知识库中的数据生成标准化的Markdown文档；使用 '/melly:draw-c4model' 命令则可以生成Mermaid图表和Obsidian Canvas文件，用于可视化系统架构。

通过这些集成步骤，Melly的代理和技能将能够从 'Basic Memory' MCP服务器高效检索和利用上下文知识，从而实现更智能的代码分析、洞察和文档生成。

信息

分类

开发者工具

访问项目