项目简介

WhoAmI MCP 服务器是一个遵循 Model Context Protocol (MCP) 标准实现的后端服务。它提供了一个简单的工具,用于获取运行该服务器的系统的当前用户名。设计简洁,易于部署和集成到支持MCP协议的LLM客户端中。

主要功能点

  • 获取系统用户名: 提供一个标准的MCP工具接口,允许连接的LLM客户端查询并获取当前系统的用户名称。
  • 轻量高效: 服务器实现简单,运行快速,适合作为本地LLM集成的上下文来源。

安装步骤

  1. 克隆仓库: 打开终端,使用以下命令下载项目代码:
    git clone https://github.com/kukapay/whoami-mcp.git
  2. 进入项目目录。
  3. 确保您已经安装了 Python 3.10 或更高版本以及 'uv'(一个快速的 Python 包安装和执行工具)。如果您没有安装 'uv',可以使用 pip 安装:'pip install uv'。'uv' 将用于运行服务器。

服务器配置(在您的 MCP 客户端中)

WhoAmI MCP 服务器本身是一个后台进程,需要由您的MCP客户端启动和管理。您需要在支持MCP的LLM客户端的配置中添加以下信息,告诉客户端如何启动和连接到此服务器。

配置通常是一个 JSON 格式的片段,指定服务器的名称以及启动该服务器的命令和参数。以下是基于 WhoAmI 项目结构生成的配置示例的含义(请参考您的客户端文档进行具体配置):

  • 服务器名称 (server name): 您为这个服务器实例指定的名称,例如 '"whoami"'。
  • 启动命令 (command): 客户端用于启动服务器的可执行文件路径。通常是 'uv'。
  • 启动参数 (args): 传递给启动命令的参数列表。例如:
    • '"--directory"' 后接服务器代码所在的路径(例如您克隆仓库的位置)。
    • '"run"' 告诉 'uv' 运行一个 Python 脚本。
    • '"main.py"' 指定要运行的服务器主文件。

示例配置逻辑(非实际代码,供理解): 在一个名为 '"mcpServers"' 的配置部分下,添加一个条目,键为您希望引用的服务器名称(如 '"whoami"')。该条目的值是一个对象,包含 '"command"' 和 '"args"' 字段。

  • '"command": "uv"'
  • '"args": ["--directory", "path/to/your/whoami_mcp_folder", "run", "main.py"]'

请将 '"path/to/your/whoami_mcp_folder"' 替换为您实际克隆 'whoami-mcp' 仓库的本地路径。

基本使用方法

一旦您的MCP客户端配置并成功连接到 WhoAmI MCP 服务器,您就可以通过客户端调用该服务器提供的工具。

  • 工具名称: 'whoami'
  • 功能: 调用此工具将返回服务器当前所运行系统的用户名。LLM客户端可以利用这个信息来获取关于用户环境的基本上下文。

信息

分类

开发者工具