使用说明

项目简介

Floword 是一个基于 Model Context Protocol (MCP) 构建的应用后端，它充当 MCP 服务器的角色，旨在简化和标准化 LLM 应用与外部工具和资源的集成。Floword 提供了资源管理、工具注册与执行、Prompt 模板渲染等核心功能，并通过 JSON-RPC 协议与客户端进行通信，是构建复杂 LLM 工作流的理想选择。

主要功能点

资源管理 (Resources): Floword 能够托管和管理各种外部数据资源，并提供统一的数据访问能力，让 LLM 可以便捷地获取所需信息。
工具集成 (Tools): 允许注册和执行外部工具服务，扩展 LLM 的能力边界，例如调用 API、访问数据库等，实现更复杂的功能。
Prompt 模板 (Prompts): 支持定义和渲染 Prompt 模板，实现可定制的 LLM 交互模式，优化 LLM 的输出效果。
JSON-RPC 通信: 采用标准的 JSON-RPC 协议与客户端通信，确保了互操作性和易用性。
多种传输协议支持: 理论上支持 Stdio, SSE, WebSocket 等多种传输协议（仓库示例主要展示 Stdio 和 SSE）。
会话管理和能力声明: 服务器端负责会话管理和能力声明，为 LLM 应用提供安全、可扩展的上下文服务框架。

安装步骤

安装 uv (推荐): Floword 推荐使用 uv 进行环境管理和安装。根据您的操作系统，执行以下命令安装 uv：

macOS/Linux:

curl -LsSf https://astral.sh/uv/install.sh | sh

Windows:

powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"

运行 Floword 服务器: 使用 uvx 命令运行 Floword 服务器：

uvx floword@latest strat

或者，您可以使用 Docker 镜像：

docker pull ghcr.io/ai-zerolab/floword:latest

服务器配置

Floword 服务器的配置主要通过环境变量进行，环境变量需要以 'FLOWORD_' 为前缀（不区分大小写）。以下是一个 MCP 客户端连接 Floword 服务器时 'mcpServers' 配置示例 (JSON 格式)：

{
  "floword-server": {
    "command": "uvx",
    "args": ["floword@latest", "start"]
  }
}

配置参数说明:

'server name': 'floword-server' (服务器名称，客户端用于识别和连接)
'command': 'uvx' (启动服务器的命令，这里使用 uvx 运行 floword)
'args': '["floword@latest", "start"]' (传递给启动命令的参数，'floword@latest' 指定使用最新版本的 floword，'start' 是 floword 的启动命令)

基本使用方法

启动 Floword 服务器: 按照安装步骤启动 Floword 服务器。
配置 MCP 客户端: 在您的 MCP 客户端应用中，配置连接 Floword 服务器的 'mcpServers' 信息，如上面的 JSON 示例。
客户端请求: 客户端通过 JSON-RPC 协议向 Floword 服务器发送请求，例如读取资源、调用工具、获取 Prompt 等。
服务器响应: Floword 服务器处理客户端请求，并返回 JSON-RPC 响应或发送通知。

注意: Floword 仓库主要提供了后端服务器的实现，您需要根据 MCP 协议规范开发或使用兼容的 MCP 客户端应用与之交互。

关键词

使用说明

信息