使用说明
ioBroker.mcp服务器
测验:
ioBroker的mcp服务器适配器
一个MCP服务器,通过任何MCP客户端的AI控制io代理
开发人员手册
本节面向开发人员。稍后可以删除。
免责声明
请确保在使用公司名称或徽标时考虑版权和商标,并在README中添加免责声明。 您可以查看其他适配器以获取示例,也可以在开发人员社区中询问。未经许可使用公司的名称或徽标可能会给您带来法律问题。
入门
你几乎完成了,只剩下几步了:
-
在GitHub上创建一个名为的新存储库
ioBroker.mcp-server -
将所有文件推送到GitHub仓库。创建者已经为您设置了本地存储库:
git push origin main -
在下面添加新密码https://github.com/Holger-Will/ioBroker.mcp-server/settings/secrets.必须命名
AUTO_MERGE_TOKEN并包含一个个人访问令牌,该令牌具有对存储库的推送访问权限,例如您的。您可以在下面创建新令牌https://github.com/settings/tokens. -
前往 main.js 开始编程!
最佳实践
我们收集了一些 最佳实践 关于ioBroker的开发和编码。如果你是ioBroker或Node.js的新手,你应该 看看他们。如果你已经有经验了,你也应该看看它们——你可能会学到一些新东西:)
脚本在 package.json
为了您的方便,预定义了几个npm脚本。您可以使用以下命令运行它们 npm run <scriptname>
| 脚本名称 | 描述 |
|---|---|
test:js |
执行您在中定义的测试 *.test.js 文件夹。 |
test:package |
确保您的 package.json 和 io-package.json 是有效的。 |
test:integration |
使用ioBroker的实际实例测试适配器启动。 |
test |
对包文件和测试执行最小测试运行。 |
check |
对代码执行类型检查(无需编译任何内容)。 |
lint |
跑步 ESLint 检查代码的格式错误和潜在错误。 |
translate |
将适配器中的文本翻译成所有必需的语言,请参阅 @iobroker/adapter-dev 了解更多详情。 |
release |
创建新版本,请参阅 @alcalzone/release-script 了解更多详情。 |
编写测试
如果做得对,测试代码是无价的,因为它为您提供了 在确切知道是否以及何时更改代码的同时,有信心更改代码 有东西坏了。一本关于测试驱动开发主题的好书 是https://hackernoon.com/introduction-to-test-driven-development-tdd-61a13bc92d92. 虽然在代码之前编写测试起初可能看起来很奇怪,但它有很多 明显的好处。
该模板为您提供了适配器启动和包文件的基本测试。 建议您在组合中添加自己的测试。
发布适配器
使用GitHub Actions,您可以在每次推送与表单匹配的新git标签时在npm上启用自动发布
v<major>.<minor>.<patch>.我们 强烈推荐 您可以这样做。必要的步骤在中进行了描述 .github/workflows/test-and-release.yml.
安装了发布脚本后,您可以创建一个新的 只需拨打以下电话即可释放:
npm run release
发布脚本的其他命令行选项在 发布脚本文档.
要在ioBroker中发布适配器,请参阅文档 属于的 ioBroker存储库.
使用开发服务器手动测试适配器
自从你建立 dev-server,您可以使用它来运行、测试和调试适配器。
你可以开始了 dev-server 从您的开发目录调用:
dev-server watch
ioBroker.admin界面将在http://localhost:8081/
请参阅 dev-server 文档 了解更多详情。
更新日志
进行中
- (Holger Will)首次发布
许可证
MIT许可证
版权所有(c)2025霍尔格·威尔 h.will@klimapartner.de
特此免费向任何获得副本的人授予许可 本软件和相关文档文件(“软件”),以处理 在软件中不受限制,包括但不限于权利 使用、复制、修改、合并、发布、分发、再许可和/或销售 软件的副本,并允许软件的接收者 根据以下条件提供:
上述版权声明和本许可声明应包含在所有 软件的副本或实质性部分。
软件按“原样”提供,不提供任何形式的明示或明示担保 隐含的,包括但不限于适销性保证, 适用于特定目的且不造成伤害。在任何情况下 作者或版权持有人对任何索赔、损害赔偿或其他 因以下原因产生的责任,无论是在合同、侵权或其他诉讼中, 出于或与软件、使用或其他交易有关 软件。