使用说明

项目简介

Klavis AI 致力于构建开源基础设施，让 Model Context Protocol (MCP) 易于所有人使用。该项目提供了一系列 MCP 服务器和服务，旨在简化 LLM 应用的开发流程，降低非技术用户使用 AI 工作流的门槛。

主要功能点

资源 (Resources) 管理: Klavis 托管和管理多种类型的资源，例如数据库、文档转换工具、YouTube 内容等，并提供标准化的数据访问能力。
工具 (Tools) 注册与执行: 集成并管理各种工具，包括 Report Generation, YouTube tools, Document Converters, GitHub 操作, Slack/Discord 集成等，允许 LLM 客户端调用外部功能。
Prompt 模板 (Prompts) 支持: 虽然仓库信息中没有明确提及 Prompt 模板，但 MCP 的定义包含此项功能，Klavis 作为 MCP 服务器实现，理论上支持 Prompt 模板的定义和渲染，以支持可定制的 LLM 交互模式。
多样化的客户端支持: 提供 Slack 和 Discord 客户端，以及简单的 Web UI，方便用户在不同的平台中使用 MCP 服务器的功能。
易于扩展的架构: Klavis 架构清晰，易于扩展新的工具和客户端平台，开发者可以方便地添加自定义功能。

安装步骤

克隆仓库: 使用 'git clone https://github.com/Klavis-AI/klavis' 克隆 GitHub 仓库到本地。
环境配置:
- 查看 'mcp_servers' 目录下各个服务器文件夹中的 'README.md' 文件，了解每个服务器的具体依赖和配置要求。
- 通常需要安装 Python 或 Node.js 环境，并根据服务器的 'README.md' 安装所需的依赖包 (例如 Python 使用 'pip install -r requirements.txt'，Node.js 使用 'npm install' 或 'yarn install')。
- 部分服务器可能需要配置环境变量，例如 API 密钥、数据库连接字符串等，请参考各个服务器文件夹下的 'README.md' 文件。
启动 MCP 服务器:
- 进入 'mcp_servers' 目录下相应的服务器文件夹 (例如 'mcp_servers/pandoc')。
- 根据服务器类型，运行启动命令。例如 Python 服务器通常运行 'python server.py'，Node.js 服务器可能需要 'npm start' 或 'node index.js'，Go 服务器需要先编译再运行，具体请参考各服务器文件夹下的 'README.md' 文件。
- 服务器默认端口通常为 5000，具体端口信息请参考各服务器的代码或 'README.md'。

服务器配置

MCP 客户端需要配置 MCP 服务器的启动命令 (command) 及其参数 (args) 才能与MCP服务器建立连接。以下是一些示例配置信息，请根据实际使用的 MCP 服务器进行调整：

[
  {
    "server_name": "Pandoc Server",
    "command": "python",
    "args": ["mcp_servers/pandoc/server.py"],
    "description": "文档转换服务，支持 Markdown 到 PDF, DOCX, HTML 等格式的转换"
  },
  {
    "server_name": "YouTube Server",
    "command": "python",
    "args": ["mcp_servers/youtube/server.py"],
    "description": "YouTube 内容处理服务，可以将 YouTube 视频转为 Markdown 格式"
  },
  {
    "server_name": "Discord Server",
    "command": "python",
    "args": ["mcp_servers/discord/server.py"],
    "description": "Discord API 集成服务，提供 Discord 相关的工具"
  },
  {
    "server_name": "Resend Email Service",
    "command": "node",
    "args": ["mcp_servers/resend/index.ts"],
    "description": "Resend 邮件发送服务"
  },
  {
    "server_name": "Postgres Server",
    "command": "node",
    "args": ["mcp_servers/postgres/index.ts"],
    "description": "PostgreSQL 数据库操作服务"
  },
  {
    "server_name": "Firecrawl Web Scraper",
    "command": "node",
    "args": ["mcp_servers/firecrawl/index.ts"],
    "description": "Firecrawl 网页抓取服务，提供多种网页数据抓取和分析工具"
  },
  {
    "server_name": "Firecrawl Deep Research",
    "command": "node",
    "args": ["mcp_servers/firecrawl_deep_research/index.ts"],
    "description": "Firecrawl 深度研究服务，结合网页抓取、搜索和 AI 分析进行深度信息挖掘"
  },
  {
    "server_name": "Slack Server",
    "command": "node",
    "args": ["mcp_servers/slack/index.ts"],
    "description": "Slack API 集成服务，提供 Slack 相关的工具"
  },
  {
    "server_name": "GitHub Server",
    "command": "go",
    "args": ["run", "mcp_servers/github/sse_server.go"],
    "description": "GitHub API 集成服务，提供 GitHub 仓库操作相关的工具"
  },
  {
    "server_name": "Supabase Server",
    "command": "node",
    "args": ["mcp_servers/supabase/src/sse.ts"],
    "description": "Supabase 管理 API 服务"
  },
  {
    "server_name": "Report Generation Server",
    "command": "python",
    "args": ["mcp_servers/report_generation/server.py"],
    "description": "网页报告生成服务，根据搜索查询生成 JavaScript 网页报告"
  },
  {
    "server_name": "Markitdown File Reader",
    "command": "python",
    "args": ["mcp_servers/markitdown/server.py"],
    "description": "文件读取和转换服务，支持多种文档格式转为 Markdown"
  }
]

基本使用方法

启动 MCP 服务器: 按照安装步骤启动你需要的 MCP 服务器。
配置 MCP 客户端: Klavis 提供了 Discord 和 Slack 客户端，以及基础客户端，你可以根据需要配置和使用这些客户端连接到已启动的 MCP 服务器。具体的客户端配置方法请参考仓库中 'mcp_clients' 目录下相应客户端的 'README.md' 文件。
通过客户端与 LLM 交互: 使用配置好的 MCP 客户端（例如 Discord Bot 或 Slack Bot），即可通过自然语言与 LLM 进行交互，并利用 MCP 服务器提供的资源和工具。例如，你可以指示 LLM 使用 Report Generation 工具生成网页报告，或使用 YouTube 工具分析 YouTube 视频内容。

关键词

使用说明

信息