使用说明

项目简介

MCP PIF (Personal Intelligence Framework) 是一个 Model Context Protocol (MCP) 服务器的 TypeScript 实现,旨在构建人与 AI 之间更结构化和有意义的交互。它提供了一系列工具,如文件系统操作、知识记录(Journal)和思维组织工具,帮助用户和 AI 协同工作,构建个人智能框架。

主要功能点

  • 资源管理 (Resources): 通过文件系统工具,允许 LLM 客户端访问和操作服务器工作区内的文件和目录。
  • 工具注册和执行 (Tools): 提供文件操作、日志记录、思维组织等多种工具,允许 LLM 客户端调用这些工具来扩展自身能力。
  • 会话管理: 服务器端管理客户端会话,为每个会话提供独立的工作空间和上下文。
  • 跨平台支持: 支持 Windows、macOS 和 Linux 操作系统。

安装步骤

  1. 克隆仓库:

    git clone https://github.com/hungryrobot1/MCP-PIF
    cd MCP-PIF
  2. 安装依赖: 确保已安装 Node.js 18+ 和 npm,然后运行:

    npm install
  3. 构建项目:

    npm run build

服务器配置

要将 MCP PIF 服务器配置到 MCP 客户端(例如 Claude Desktop Client),您需要提供服务器的启动命令和参数。以下是 Claude Desktop Client 'claude_desktop_config.json' 文件的配置示例:

{
    "mcpServers": {
        "mcp-pif": {
            "command": "node",
            "args": ["/path/to/your/MCP-PIF/build/index.js"],
            "cwd": "/path/to/your/MCP-PIF",
            "env": {}
        }
    }
}

配置参数说明:

  • '"mcpServers"': 定义 MCP 服务器配置的 JSON 对象。
  • '"mcp-pif"': 服务器名称,您可以自定义,客户端通过此名称连接服务器。
  • '"command"': 启动服务器的命令,这里使用 'node' 运行 JavaScript 文件。
  • '"args"': 启动命令的参数,指向构建后的 'index.js' 文件路径。请将 '/path/to/your/MCP-PIF' 替换为您实际的仓库路径。
  • '"cwd"': 服务器进程的工作目录,设置为仓库根目录。请将 '/path/to/your/MCP-PIF' 替换为您实际的仓库路径。
  • '"env"': 环境变量,可以根据需要设置,默认为空。

注意:

  • 请根据您的操作系统修改路径分隔符 (Windows 使用 '',macOS/Linux 使用 '/')。但通常情况下,配置中可以使用 '/',路径会自动标准化。
  • 确保 Claude Desktop Client 能够访问到 'node' 命令和 'index.js' 文件。

基本使用方法

  1. 启动 Claude Desktop Client: 配置完成后,启动或重启 Claude Desktop Client。
  2. 选择自定义服务器: 在 Claude Desktop Client 中选择 "mcp-pif" 作为您的自定义服务器。
  3. 开始对话: 开始新的聊天,即可使用 MCP PIF 服务器提供的工具。

可用工具示例:

  • 使用 'read' 工具读取文件内容:

    {
      "tool_calls": [
        {
          "id": "call_123",
          "type": "function",
          "function": {
            "name": "read",
            "arguments": "{\"path\": \"home/meta/journal/README.md\"}"
          }
        }
      ]
    }
  • 使用 'journal_create' 工具创建新的日志条目:

    {
      "tool_calls": [
        {
          "id": "call_456",
          "type": "function",
          "function": {
            "name": "journal_create",
            "arguments": "{\"title\": \"Daily Reflection\", \"content\": \"Today I worked on...\", \"tags\": [\"reflection\", \"daily\"]}"
          }
        }
      ]
    }

请参考仓库的 Module DocumentationArchitecture Guide 了解更多工具的详细用法。

信息

分类

开发者工具