使用说明

项目简介

Omikuji MCP Server 是一个基于 Model Context Protocol (MCP) 构建的实验性服务器,旨在为 LLM 客户端提供抽签算命的功能。通过调用预设的 'draw_fortune' 工具,用户可以获得随机的运势结果、详细的运势解释以及今日建议。

主要功能点

  • 抽签算命: 提供大吉、中吉、小吉、末吉、凶 五种运势结果。
  • 运势详解: 针对每种运势提供详细的解释说明。
  • 每日建议: 根据抽签结果提供相应的建议。
  • 指定名称抽签: 允许用户在抽签时指定名称,结果中会包含该名称。
  • MCP 工具: 通过 MCP 协议的工具 (Tool) 机制暴露 'draw_fortune' 功能,方便 LLM 客户端调用。

安装步骤

  1. 通过 npm 安装 (推荐):

    npm install @sunwood-ai-labs/omikuji-mcp-server
  2. 或者从 GitHub 克隆并安装:

    git clone https://github.com/Sunwood-ai-labs/omikuji-mcp-server.git
    cd omikuji-mcp-server
    npm install
    npm run build

服务器配置

要将 Omikuji MCP Server 集成到 MCP 客户端,需要在客户端的 MCP 配置文件中添加以下服务器配置信息。这告诉 MCP 客户端如何启动和连接到 Omikuji 服务器。

{
  "mcpServers": {
    "omikuji": {  // 服务器名称,可以自定义,例如 "my-omikuji-server"
      "command": "node",  // 启动服务器的命令,这里使用 Node.js 运行 JavaScript 文件
      "args": ["node_modules/@sunwood-ai-labs/omikuji-mcp-server/build/index.js"] // 启动命令的参数,指向服务器入口文件
    }
  }
}

配置说明:

  • '"omikuji"': 是您为这个 Omikuji MCP 服务器定义的名称。在客户端中,您将使用这个名称来引用该服务器。您可以根据需要更改此名称。
  • '"command": "node"': 指定用于启动服务器的命令。由于 Omikuji MCP Server 是用 Node.js 编写的,因此这里使用 'node' 命令来运行 JavaScript 文件。
  • '"args": ["node_modules/@sunwood-ai-labs/omikuji-mcp-server/build/index.js"]': 'args' 数组包含了传递给 'command' 的参数。这里,参数指向了 Omikuji MCP Server 的入口文件 'index.js',该文件位于 'node_modules/@sunwood-ai-labs/omikuji-mcp-server/build/' 目录下。 'build' 目录是项目构建后的输出目录。

注意: 请确保您的 MCP 客户端能够正确解析和加载 MCP 配置文件,并将以上配置添加到相应的配置节中。

基本使用方法

配置完成后,您可以通过 MCP 客户端调用 'draw_fortune' 工具来使用 Omikuji MCP Server 的抽签功能。

调用 'draw_fortune' 工具的请求示例 (JSON-RPC request):

1. 不指定名称 (默认参拜者):

{
  "jsonrpc": "2.0",
  "method": "call_tool",
  "params": {
    "name": "draw_fortune",
    "arguments": {}
  },
  "id": 1
}

2. 指定名称 (例如 "张三"):

{
  "jsonrpc": "2.0",
  "method": "call_tool",
  "params": {
    "name": "draw_fortune",
    "arguments": {
      "name": "张三"
    }
  },
  "id": 2
}

服务器响应示例 (JSON-RPC response): 服务器会返回包含抽签结果的 JSON-RPC 响应,内容 (content) 部分会包含文本格式的抽签结果,例如:

{
  "jsonrpc": "2.0",
  "result": {
    "content": [
      {
        "type": "text",
        "text": "\n🎋 参拝者さんの運勢\n\n【結果】 大吉\n\n【運勢の詳細】\n素晴らしい1日になるでしょう\n\n【今日のアドバイス】\n深呼吸をして、リラックスすることを忘れずに\n\nおみくじの結果に一喜一憂せず、前向きな気持ちで過ごしましょう。\n"
      }
    ]
  },
  "id": 1
}

请根据您的 MCP 客户端的具体使用方式,发送相应的 JSON-RPC 请求来调用 'draw_fortune' 工具,并解析服务器返回的响应以获取抽签结果。

信息

分类

AI与计算