项目简介
'devvit-mcp' 是一个实现了 Model Context Protocol (MCP) 标准的服务器,专门用于增强基于Reddit开发者平台(Devvit)的应用开发体验。它作为LLM客户端(如支持MCP的IDE或聊天应用)的后端,提供与Devvit平台相关的上下文信息和操作能力。
主要功能点
- Devvit文档搜索: 通过 'devvit_search' 工具,LLM可以直接搜索Devvit平台的官方文档,获取相关的开发指南、API参考等信息,帮助开发者快速找到答案。支持版本查询、模糊搜索等。
- Devvit日志访问: 通过 'devvit_logs' 工具,LLM可以调用Devvit CLI命令,获取特定社区或应用的运行日志,辅助开发者进行调试和故障排查。
- 能力声明: 服务器向连接的LLM客户端声明其提供的能力,包括工具(Tools)和资源(Resources),使客户端能够了解并利用这些功能。
- 日志通知: 服务器支持通过MCP协议发送日志消息给客户端,便于在开发环境中查看服务器的内部运行情况。
安装步骤
该MCP服务器通常由兼容MCP的LLM客户端自动启动。您需要在客户端的配置文件(通常是 'mcp.json' 或类似的设置界面)中添加该服务器的配置。
服务器配置
要将此MCP服务器添加到您的MCP客户端,您需要更新客户端的配置文件。以下是配置示例及其说明:
在一个 'mcp.json' 文件中,找到 'mcpServers' 部分,并添加一个名为 'devvit-mcp' 的条目。
配置示例(请根据您的客户端实际配置格式进行调整):
{ "mcpServers": { "devvit-mcp": { "command": "npx", // 启动MCP服务器进程的命令,这里使用npx来执行安装在node_modules或npm registry中的devvit mcp包 "args": ["-y", "@devvit/mcp"] // 传递给command的参数。-y表示确认安装,@devvit/mcp是服务器的npm包名 } } }
或者,如果您在本地克隆了仓库并进行开发或测试,可以使用本地路径启动:
{ "mcpServers": { "devvit-mcp": { "command": "/path/to/your/node", // 您本地Node.js运行时的完整路径 "args": ["/path/to/your/devvit-mcp/dist/index.js"] // devvit-mcp仓库dist目录下的主文件路径 } } }
完成配置后,重新启动您的MCP客户端,它应该能够发现并连接到Devvit MCP服务器。
基本使用方法
一旦Devvit MCP服务器成功连接到您的LLM客户端,其提供的工具和资源能力将自动集成到LLM的上下文中。
您可以通过与LLM自然语言交流来使用这些能力:
- 搜索文档: 直接在LLM聊天窗口提问关于Devvit平台开发的问题,例如:“如何使用Devvit的useState hook?”或“explain the Devvit scheduler tool”。LLM会识别您的意图,并自动调用 'devvit_search' 工具来查找相关文档片段并作为回复提供给您。
- 获取日志: 请求LLM获取特定子社区或应用的日志,例如:“get logs for subreddit r/mytestsub”或“show me the latest logs for myapp in devvit-testing --since 10m”。LLM会调用 'devvit_logs' 工具并返回命令行输出。
您不需要记住特定的命令格式;LLM会根据其对工具的理解来调用它们。服务器的日志信息可能会显示在LLM客户端的输出或日志面板中。
信息
分类
开发者工具