关键词

Quail内容管理API 访问LLM 工具个人知识库

使用说明

项目简介

'Quail CLI MCP服务器' 是一个基于 Quail CLI 命令行工具扩展的 MCP (Model Context Protocol) 服务器实现。它允许 LLM 客户端通过标准的 MCP 协议，访问和操作 Quail 平台上的内容资源，并利用 Quail CLI 提供的工具能力，例如获取用户频道列表、搜索帖子、发布帖子等。

主要功能点

  • 资源管理: 提供对 Quail 平台用户频道列表的资源访问，允许 LLM 获取频道信息。
  • 工具集成: 注册并提供一系列实用工具，包括：
    • 'login': 通过 OAuth 登录 Quail 平台。
    • 'get_my_channels': 获取当前用户的所有频道列表。
    • 'get_my_channel_posts': 获取指定频道下的帖子列表。
    • 'get_post': 获取指定帖子详情。
    • 'get_post_content': 获取指定帖子的内容（包括免费和付费内容）。
    • 'publish_post': 发布新帖子到指定频道。
    • 'search_post': 在 Quail 平台上搜索帖子。
    • 'get_quaily_url': 获取频道或帖子的 Quaily 平台 URL。
  • 多协议支持: 支持 SSE (Server-Sent Events) 和 Stdio 两种传输协议，方便不同类型的 MCP 客户端连接。
  • 易于使用: 基于 Quail CLI，安装和配置简单，可以通过命令行快速启动 MCP 服务器。

安装步骤

  1. 安装 Quail CLI:

    • 下载预编译版本: 访问 Releases 页面，下载适合您操作系统的最新版本二进制文件。解压后将 'quail-cli' 可执行文件添加到您的系统 'PATH' 环境变量中。
    • 手动安装 (Go): 确保您已安装 Go 语言环境。打开终端，运行命令： 
      go install github.com/quailyquaily/quail-cli@latest
      安装完成后，'quail-cli' 可执行文件通常位于 '$HOME/go/bin' 目录，请将其添加到 'PATH' 环境变量。

  2. 登录 Quail 平台:

    • 打开终端，运行命令 'quail-cli login'。
    • 按照终端提示访问 OAuth 授权链接，完成登录授权。登录信息将保存在配置文件 '~/.config/quail-cli/config.yaml' 中。

服务器配置

以下是 MCP 客户端连接 'Quail CLI MCP服务器' 的配置信息示例 (JSON 格式)。请根据您选择的模式 (SSE 或 Stdio) 配置客户端。

SSE 模式配置 (示例)

{
  "serverName": "Quail CLI MCP Server (SSE)",
  "command": "quail-cli",
  "args": ["mcp", "--sse", "--port", "8083"],
  "notes": "配置 MCP 客户端连接到 SSE 模式的 Quail CLI MCP 服务器。服务器将监听 8083 端口。请确保已安装 quail-cli 并已添加到 PATH 环境变量。首次使用前需要运行 'quail-cli login' 完成登录。"
}

Stdio 模式配置 (示例)

{
  "serverName": "Quail CLI MCP Server (Stdio)",
  "command": "/your_install_path/quail-cli",
  "args": ["mcp"],
  "notes": "配置 MCP 客户端连接到 Stdio 模式的 Quail CLI MCP 服务器。请将 '/your_install_path/quail-cli' 替换为 quail-cli 可执行文件的实际安装路径。首次使用前需要运行 'quail-cli login' 完成登录。"
}

注意:

  • 'command' 字段需要指定 'quail-cli' 可执行文件的路径。如果是手动安装，请确保路径正确。
  • 首次使用 MCP 服务器前，必须先使用 'quail-cli login' 命令完成 Quail 平台登录和授权。
  • SSE 模式默认监听 '8083' 端口，可以通过 '--port' 参数自定义端口。

基本使用方法

  1. 启动 MCP 服务器:

    • SSE 模式: 在终端运行 'quail-cli mcp --sse' (或 'quail-cli mcp --sse --port <自定义端口>')。
    • Stdio 模式: 在终端运行 '/your_install_path/quail-cli mcp' (请替换为实际路径)。

  2. 配置 MCP 客户端:

    • 根据您选择的模式 (SSE 或 Stdio)，将上述提供的 JSON 配置信息添加到您的 MCP 客户端配置中。
    • 确保 MCP 客户端能够正确连接到 'Quail CLI MCP服务器' 的地址 (SSE 模式为 'http://localhost:8083/sse' 或自定义地址，Stdio 模式为管道)。

  3. 通过 LLM 客户端与 Quail 平台交互:

    • 在 LLM 客户端中使用自然语言指令，例如：
    • 'what are my channels?' (调用 'get_my_channels' 工具)
    • 'search for posts about AI' (调用 'search_post' 工具，关键词 "AI")
    • 'publish a post to my channel 'my-channel' with title 'Hello' and content 'This is a test post.'' (调用 'publish_post' 工具，并提供标题、频道、内容等参数)
    • LLM 客户端将根据指令自动调用 'Quail CLI MCP服务器' 提供的工具和资源，获取信息或执行操作。

信息

分类

开发者工具

访问项目