使用说明

oterm 主要是一个基于终端的 Ollama 客户端,但它也包含了一个 MCP 服务器的示例,用于演示工具集成。这个服务器主要用于 oterm 的测试,展示了 oterm 如何通过 MCP 协议与外部功能进行交互。

项目简介

这个 MCP 服务器示例是 oterm 项目的一部分,旨在演示 MCP 协议的基本功能,例如资源管理和工具注册。它提供了一个简单的 "oracle" 工具和一个 "config://app" 资源,用于演示客户端如何通过 MCP 协议访问服务器端的功能和数据。

主要功能点

  • 资源托管: 提供了一个名为 'config://app' 的资源,客户端可以访问以获取服务器配置信息。
  • 工具注册: 注册了一个名为 'oracle' 的工具,客户端可以调用该工具执行查询并获取预设的响应。
  • 测试目的: 主要用于 oterm 客户端的 MCP 工具集成测试和功能演示。

安装步骤

由于 MCP 服务器示例是 oterm 项目的一部分,您无需单独安装。安装 oterm 客户端即可包含该服务器示例代码。

请参考 oterm 客户端的安装指南进行安装:

uvx oterm

更多安装细节请参考 oterm Documentation

服务器配置

要将此 MCP 服务器示例与 MCP 客户端(例如 oterm,当配置使用 MCP 工具时)配合使用,您需要在客户端中配置连接信息。服务器被设计为由客户端作为子进程启动。以下是一个示例配置,您需要将其添加到 MCP 客户端的服务器配置中:

{
  "oracle": {
    "command": "mcp",
    "args": ["run", "tests/tools/mcp_servers.py"]
  }
}

配置项说明:

  • 'oracle': 服务器名称,您可以自定义,用于在客户端配置中标识该服务器。
  • 'command': 启动 MCP 服务器的命令。这里 'mcp' 假设已安装在您的系统 PATH 环境变量中 (它是 'mcp-python-sdk' 的一部分,oterm 依赖于此 SDK)。
  • 'args': 传递给命令的参数。 'run tests/tools/mcp_servers.py' 指示 'mcp' 命令运行 Python 脚本 'tests/tools/mcp_servers.py',该脚本包含了服务器的具体实现。 'tests/tools/mcp_servers.py' 的路径是相对于 oterm 项目根目录而言的。

基本使用方法

  1. 配置客户端: 在您的 MCP 客户端配置中添加上述服务器配置信息。确保客户端能够找到并执行 'mcp' 命令,并能访问到 'tests/tools/mcp_servers.py' 脚本(通常在 oterm 项目的本地副本中)。
  2. 启动客户端: 启动您的 MCP 客户端(例如配置了 MCP 工具的 oterm 客户端)。客户端将根据配置尝试连接到 MCP 服务器示例。
  3. 使用工具和资源: 客户端连接成功后,您应该能够发现并调用服务器提供的 'oracle' 工具,并访问 'config://app' 资源。具体使用方法请参考您的 MCP 客户端的文档。在 oterm 中,您可以在聊天中使用配置的 MCP 工具来与服务器进行交互。

请注意,此 MCP 服务器示例主要是为了演示和测试目的,可能不适用于生产环境。

信息

分类

开发者工具