使用说明

项目简介

Hapax文档助手是Hapax框架的可选组件，以MCP服务器的形式提供，旨在通过AI工具增强Hapax文档和源码的可访问性。它允许AI助手（如Cursor中的Agent）通过预定义的工具与Hapax文档和源码进行交互，从而帮助开发者更高效地理解和使用Hapax框架。

主要功能点

智能文档搜索: 允许AI助手根据自然语言查询搜索Hapax文档和源代码，快速定位相关信息。
源码导航: 提供工具，使AI助手能够浏览和理解Hapax的源代码结构和实现细节。
实现指导: 针对特定的Hapax使用模式或功能，提供代码示例和实现指南。
问题排查: 帮助开发者诊断和解决在使用Hapax时遇到的错误和问题。
主题探索: 支持对Hapax框架的各个概念和主题进行深入探索。

安装步骤

确保已安装 Hapax 框架。如果尚未安装，请先安装 Hapax：
```
pip install hapax
```
安装 Hapax 文档助手组件。通过安装 'hapax[assistant]' 扩展来安装文档助手：
```
pip install "hapax[assistant]"
```

服务器配置

对于 MCP 客户端（例如 Cursor），需要配置 MCP 服务器的启动命令。以下是配置信息，请复制到 MCP 客户端的配置中。

Cursor 全局配置 (config.json):

如果您希望全局配置 Hapax 文档助手，请将以下 JSON 配置添加到 Cursor 的 'config.json' 文件中（通常位于 Cursor 配置目录的 'mcp' 子目录下）：

{
  "servers": {
    "hapax-docs": {
      "command": "python",
      "args": ["-m", "hapax_docs.server"],
      "transport": "stdio",
      "name": "Hapax Documentation Assistant",
      "version": "0.1.0",
      "description": "Documentation assistant for the Hapax framework",
      "enabled": true
    }
  }
}

Cursor 项目配置 (mcp.json 或 .cursor/mcp.json):

如果您希望为特定项目配置 Hapax 文档助手，可以在项目根目录或 '.cursor' 目录下创建 'mcp.json' 文件，并添加以下 JSON 配置：

{
  "mcpServers": {
    "hapax-docs": {
      "command": "python",
      "args": ["-m", "hapax_docs.server"],
      "transportType": "stdio"
    }
  }
}

配置参数说明:

'command': 启动 MCP 服务器的命令，这里使用 'python'。
'args': 传递给 'python' 命令的参数，'-m hapax_docs.server' 表示以模块方式运行 'hapax_docs.server'。
'transport': 指定 MCP 客户端和服务器之间的通信方式，'stdio' 表示标准输入输出流。
'transportType': 在项目配置文件中使用的传输类型键名。
'name': 在 Cursor MCP 服务器列表中显示的服务名称，可以自定义。
'version': MCP 服务器的版本，这里设置为 '0.1.0'。
'description': MCP 服务器的描述信息，用于在 Cursor 中提供更详细的说明。
'enabled': 是否启用该 MCP 服务器，设置为 'true' 表示启用。

基本使用方法

配置完成后，在 Cursor 中打开您的 Hapax 项目，即可通过 Agent (Composer) 功能与 Hapax 文档助手进行交互。

在 Cursor Composer 中，您可以尝试以下操作：

提问关于 Hapax 文档的问题: 例如 "How do I use the Graph component in Hapax?" 或 "Search for documentation about operations in Hapax"。
指定使用工具: 例如 "Use the search_docs tool to find information about error handling in Hapax"。
利用 Agent 的自动工具选择: Agent 会根据您的问题，自动选择合适的 MCP 工具来提供答案。

文档助手提供了一系列工具，例如 'search_docs'（文档搜索）、'get_section_content'（获取章节内容）、'get_implementation_pattern'（获取实现模式）、'get_source_element'（查看源代码）等，Agent 会在需要时自动调用这些工具来辅助您理解和使用 Hapax 框架。

关键词