项目简介

Tusk (象牙) 是一个专为AI代理设计的持久化记忆工具,致力于帮助开发者更好地管理工作进度、恢复上下文并自动生成站会报告。它解决了AI会话中上下文丢失的问题,确保重要工作细节不被遗忘,并通过内置指令指导AI代理自动进行检查点记录。

主要功能点

  • 上下文恢复 (Context Recovery): 记录工作细节,防止AI会话崩溃或上下文被截断时丢失关键信息。
  • AI主动行为 (Proactive AI Behavior): 内置指令鼓励AI代理自动创建检查点,提高工作连续性。
  • 站会报告生成 (Beautiful Standups): 从开发日志中自动生成格式精美的会议报告,支持多种风格(如会议、书面、高管、指标)。
  • 高速性能 (Blazing Fast): 基于Bun和SQLite构建,提供即时保存和检索,并支持并发操作。
  • 简单可搜索 (Simple & Searchable): SQLite数据库支持强大的过滤和工作空间隔离功能,易于管理和查找。
  • 项目计划管理 (Plan Management): 允许LLM保存、列出、激活、更新或完成长期项目计划,这些计划在会话之间持续存在,并在上下文恢复时自动显示。

安装步骤

  1. 克隆仓库:
    git clone https://github.com/anortham/tusk tusk
    cd tusk
  2. 安装依赖:
    bun install
  3. 启动MCP服务器:
    bun run index.ts
    服务器启动后,将在后台运行并监听客户端连接。

MCP服务器配置 (Claude Desktop 示例)

您需要将Tusk MCP服务器配置到您的Claude Desktop客户端。请根据您的操作系统找到对应的配置文件('claude_desktop_config.json'),并添加如下配置项。请注意,'command' 和 'args' 中的路径必须是Tusk仓库的绝对路径。

  • macOS: '~/Library/Application Support/Claude/claude_desktop_config.json'
  • Windows: '%APPDATA%\Claude\claude_desktop_config.json'
  • Linux: '~/.config/claude/claude_desktop_config.json'

以下是配置示例,请将 '/absolute/path/to/tusk/index.ts' 替换为您本地Tusk仓库的实际路径:

{
  "mcpServers": {
    "tusk": {
      "command": "bun",
      "args": ["run", "/absolute/path/to/tusk/index.ts"]
    }
  }
}
  • Windows 路径示例:
    {
      "mcpServers": {
        "tusk": {
          "command": "bun",
          "args": ["run", "C:\\Users\\YourName\\tusk\\index.ts"]
        }
      }
    }
  • macOS/Linux 路径示例:
    {
      "mcpServers": {
        "tusk": {
          "command": "bun",
          "args": ["run", "/Users/yourname/tusk/index.ts"]
        }
      }
    }

基本使用方法 (通过Claude Desktop)

一旦配置完成,您的AI代理(如Claude)就可以通过Tusk提供的工具进行交互:

  • 记录检查点 ('checkpoint'): 保存工作进度,防止上下文丢失。
    checkpoint("Started working on the auth system")
    checkpoint("Fixed JWT timeout bug using refresh tokens")
    checkpoint("Implemented user dashboard", ["feature", "ui"])
  • 恢复上下文 ('recall'): 从之前的会话中恢复工作上下文,支持智能去重和相关性排序。
    recall()                                    // 恢复最近2天的上下文
    recall(days=7, search="auth")               // 搜索最近一周关于“auth”的上下文
    recall(project="myproject")                 // 恢复特定项目上下文
    recall(standup="meeting")                   // 恢复上下文并生成站会报告
  • 管理项目计划 ('plan'): 创建、更新和管理长期项目计划,这些计划在会话之间持续存在。
    plan(action="save", title="Q4 Roadmap", content="...") // 保存新的计划
    plan(action="list")                                   // 查看所有计划
    plan(action="update", planId="...", progress="...")   // 更新计划进度
    plan(action="complete", planId="...")                 // 完成计划

信息

分类

开发者工具