使用说明

项目简介

Bioma Tool 是一个使用 Rust 语言开发的 Model Context Protocol (MCP) 服务器。它旨在为 LLM (大型语言模型) 应用提供后端支持，根据 MCP 协议规范，实现了资源管理、工具注册与执行以及 Prompt 模板定义等核心功能。该服务器可以作为 LLM 客户端的上下文信息和功能提供者，增强 LLM 应用的能力。

主要功能点

资源管理: 服务器可以托管和管理各种资源，例如文本文件，并允许客户端通过 URI 访问这些资源。
工具执行: 服务器集成了多种实用工具，例如：
- 'echo': 一个简单的回声工具，用于测试服务器连接。
- 'memory': 一个内存存储工具，允许 LLM 存储和检索 JSON 数据。
- 'fetch': 一个网页抓取工具，可以获取指定 URL 的网页内容并提取为 Markdown 格式。
Prompt 模板: 服务器支持预定义的 Prompt 模板，允许客户端通过指定模板名称和参数来获取定制化的 Prompt。
传输协议: 支持 Stdio (标准输入输出) 和 WebSocket 两种传输协议，方便不同类型的 MCP 客户端连接。
JSON-RPC: 使用标准的 JSON-RPC 协议与客户端进行通信，保证了协议的通用性和易用性。

安装步骤

安装 Rust 环境: 确保你的系统已安装 Rust 编程环境。如果未安装，请访问 https://www.rust-lang.org/tools/install 按照指引进行安装。

克隆仓库: 使用 Git 克隆 'bioma-tool' 仓库到本地：

git clone https://github.com/VertexStudio/bioma-tool

进入项目目录: 导航到克隆下来的 'bioma-tool' 目录：
```
cd bioma-tool
```
编译服务器: 使用 'cargo build --release' 命令编译项目。编译成功后，可执行文件 'bioma-tool' 将位于 'target/release/' 目录下。

服务器配置

MCP 服务器是为 MCP 客户端设计的，客户端需要配置服务器的启动信息才能连接。以下是配置 MCP 服务器启动命令 (command) 及其参数 (args) 的 JSON 格式示例，通常在客户端的配置文件中 (例如 'claude_config.json') 进行配置：

{
    "mcpServers": {
        "bioma-tool": {
            "command": "/path/to/bioma-tool",
            "args": ["--log-file", "/path/to/mcp_server.log"]
        }
    }
}

'server name': 'bioma-tool' (服务器名称，客户端用于标识和引用该服务器).
'command': '/path/to/bioma-tool' (服务器可执行文件的路径。请将 '/path/to/bioma-tool' 替换为实际编译后 'target/release/bioma-tool' 文件的绝对路径，例如 '/Users/your_username/bioma-tool/target/release/bioma-tool').
'args': '["--log-file", "/path/to/mcp_server.log"]' (启动参数数组).
- '--log-file': 指定服务器日志文件路径。请将 '/path/to/mcp_server.log' 替换为你希望存放日志文件的路径。

WebSocket 传输配置:

如果需要使用 WebSocket 传输协议，可以在 'args' 中指定传输类型和 WebSocket 地址：

{
    "mcpServers": {
        "bioma-tool": {
            "command": "/path/to/bioma-tool",
            "args": ["--transport", "websocket", "--ws-addr", "127.0.0.1:8080", "--log-file", "/path/to/mcp_server_ws.log"]
        }
    }
}

'--transport': 设置为 'websocket' 以启用 WebSocket 传输。
'--ws-addr': 指定 WebSocket 服务器监听的地址和端口 (默认为 '127.0.0.1:8080').
'--log-file': 指定 WebSocket 传输模式下的日志文件路径。

基本使用方法

启动服务器: 在终端中执行编译后的 'bioma-tool' 文件 (例如 './target/release/bioma-tool')。如果使用 WebSocket 传输，请确保在启动参数中指定了 '--transport websocket' 和 '--ws-addr'。
配置 MCP 客户端: 根据你的 MCP 客户端软件的使用说明，配置 MCP 服务器连接信息。通常需要提供服务器的启动命令和参数，以及服务器名称。
客户端与服务器交互: 配置完成后，MCP 客户端即可连接到 Bioma Tool 服务器，并通过客户端界面或 API 调用服务器提供的资源、工具和 Prompt 模板，从而增强 LLM 应用的功能。具体操作方式请参考你的 MCP 客户端软件的使用文档。

关键词

使用说明

信息