使用说明

项目简介

GTD (Get Things Done) 待办事项应用,提供命令行、GUI和MCP服务器等多种操作界面。其中MCP服务器允许LLM客户端通过标准协议管理GTD应用中的任务。

主要功能点

  • 创建任务: 通过自然语言指令或结构化数据创建新的待办事项,可以设置标题和描述。
  • 列出任务: 查询并获取当前所有的待办事项列表。

安装步骤

  1. 克隆仓库:
    git clone https://github.com/b8kings0ga/gtd
  2. 进入仓库目录:
    cd gtd
  3. 安装依赖: 根据仓库 'README.md' 中 'Technology Stack' 部分的描述,以及代码中导入的库,可以使用 'pip' 或 'uv pip' 安装项目依赖。例如,使用 'pip' 可以执行以下命令:
    pip install -r requirements.txt
    (注意:仓库中没有明确提供 'requirements.txt' 文件,可能需要根据 'README.md' 和代码中的依赖手动安装,例如 'pip install flet typer langchain mcp-python-sdk nuitika inquirerpy async flask python-dotenv langchain-openai' 等。建议先尝试运行,根据报错信息安装缺少的库。)

服务器配置

MCP客户端需要配置以下JSON信息以连接到GTD MCP服务器:

{
  "serverName": "GTD MCP Server",
  "command": "python",
  "args": ["mcp_server.py"]
}
  • 'serverName': 为MCP服务器自定义的名称,可以根据需要修改。
  • 'command': 运行MCP服务器的命令,通常为 'python' 或 'python3'。
  • 'args': 传递给命令的参数,这里指定运行 'mcp_server.py' 文件以启动服务器。

基本使用方法

  1. 启动 MCP 服务器: 在克隆的仓库根目录下,打开终端并执行以下命令来启动 GTD MCP 服务器:

    python mcp_server.py

    服务器将默认使用 SSE (Server-Sent Events) 传输协议启动。

  2. 配置 MCP 客户端: 将上述服务器配置 JSON 信息添加到您的 MCP 客户端配置中。具体配置方法请参考您使用的 MCP 客户端的文档。

  3. 通过 LLM 客户端与 GTD MCP 服务器交互: 配置完成后,您可以通过 LLM 客户端向 GTD MCP 服务器发送请求。目前该服务器实现了两个工具:

    • 'create_task': 用于创建新任务。LLM客户端可以使用自然语言指令(如 "创建一个任务 标题为... 描述为...")来调用此工具。
    • 'list_tasks': 用于列出所有任务。LLM客户端可以使用指令(如 "列出我的任务")来调用此工具。

    具体如何通过 LLM 客户端调用这些工具,请参考您使用的 MCP 客户端的指南。

信息

分类

生产力应用