使用说明
项目简介
本项目是一个基于 Model Context Protocol (MCP) 构建的服务器,旨在向 LLM 客户端提供 Chuck Norris 的笑话。它通过定义一系列工具,允许 LLM 应用获取随机笑话、按类别获取笑话、查询笑话分类以及搜索特定笑话。此服务器部署在 Vercel 上,易于安装和使用。
主要功能点
- 获取随机笑话: 提供一个工具,用于获取一条随机的 Chuck Norris 笑话。
- 按类别获取笑话: 允许指定笑话类别,并获取该类别下的一条随机笑话。
- 获取所有类别: 提供一个工具,列出所有可用的笑话类别。
- 搜索笑话: 支持关键词搜索,返回包含关键词的 Chuck Norris 笑话。
安装步骤
-
Fork 或 Clone 仓库: 首先,将 mcp-chuck-norris 仓库 Fork 到您自己的 GitHub 账户,或者直接 Clone 到本地。
-
部署到 Vercel:
- 确保您已安装 Vercel CLI。
- 在仓库根目录下,运行 'vercel deploy' 命令。
- Vercel CLI 会引导您完成部署过程,包括关联 Vercel 项目等。
-
获取部署 URL: 部署成功后,Vercel 会提供一个部署 URL。这个 URL 将作为您的 MCP 服务器地址。
服务器配置
对于 MCP 客户端,您需要配置以下服务器信息以连接到 Chuck Norris 笑话 MCP 服务器。以下是一个 JSON 格式的配置示例,请将 'your-vercel-deployment-url' 替换为您在 Vercel 部署后获得的实际 URL。
{ "serverName": "Chuck Norris Jokes MCP Server", "command": "https://your-vercel-deployment-url/sse", "args": [], "description": "Chuck Norris 笑话 MCP 服务器", "capabilities": { "tools": [ "get-random-joke", "get-joke-from-category", "get-categories", "search-jokes" ] } }
配置参数说明:
- 'serverName': 服务器的名称,可以自定义,例如 "Chuck Norris Jokes MCP Server"。
- 'command': 重要: MCP 服务器的 SSE 连接端点。请将 'https://your-vercel-deployment-url/sse' 替换为您 Vercel 部署后获得的 URL,并在末尾加上 '/sse'。这是 MCP 客户端与服务器建立连接的关键地址。
- 'args': 启动命令的参数,本服务器无需额外参数,保持为空数组 '[]' 即可。
- 'description': 服务器的描述信息,用于客户端显示,例如 "Chuck Norris 笑话 MCP 服务器"。
- 'capabilities': 声明服务器提供的能力,'tools' 数组列出了本服务器支持的所有工具的名称。客户端会根据此信息展示可用的工具。
基本使用方法
配置完成后,在 MCP 客户端中选择 "Chuck Norris Jokes MCP Server" 服务器。客户端会加载服务器提供的工具。
您可以通过客户端界面或命令,调用以下工具来获取 Chuck Norris 笑话:
- 'get-random-joke': 获取一条随机笑话,无需任何参数。
- 'get-joke-from-category': 获取指定类别的笑话,需要提供 'category' 参数,例如 "animal", "dev", "food" 等。可以使用 'get-categories' 工具获取所有可用类别。
- 'get-categories': 获取所有可用的笑话类别,无需任何参数。
- 'search-jokes': 搜索包含特定关键词的笑话,需要提供 'query' 参数,例如 "computer", "internet" 等。关键词长度至少为 3 个字符。
例如,在 MCP 客户端中,您可以选择 'get-random-joke' 工具并执行,服务器将返回一条 Chuck Norris 的随机笑话。
您也可以使用 MCP CLI 工具进行快速测试,将 'your-vercel-deployment-url' 替换为您的 Vercel 部署 URL:
npx @modelcontextprotocol/cli your-vercel-deployment-url
信息
分类
网页与API