mcpField
T
ton-docs

ton-docs

github.com/ton-org开发10125 次安装25 周前更新
代码仓库

关于 ton-docs

ton-docs 是一项通过搜索和读取官方文档来回答 TON 问题的 skill,指导 MCP 助手开展定向检索、获取页面并整理带来源链接的答案。

主要功能

  1. 01搜索 TON 文档
  2. 02读取完整文档页面
  3. 03规划多轮检索
  4. 04整理带来源链接的答案

适用场景

  1. 01解释 TON 区块链概念
  2. 02查找智能合约示例和 API 参考
  3. 03研究 TON 标准与钱包格式

MCP 相关

它使用地址为 https://docs.ton.org/mcp 的 TON Docs 远程 MCP 服务,通过 `search_ton_docs` 搜索文档,并用 `get_page_ton_docs` 获取页面。

安装

复制下面的命令,在终端中运行。

$npx skills add https://github.com/ton-org/skills --skill ton-docs

安装后在 Claude Code 中输入/ton-docs确认已加载。

详细介绍

TON 文档

通过 TON Docs MCP 服务搜索和查阅 TON 区块链官方文档。

MCP 服务设置

TON Docs MCP 服务使用远程 HTTP 传输,无需安装本地进程。

添加到 MCP 设置中:

{
  "mcpServers": {
    "ton-docs": {
      "type": "http",
      "url": "https://docs.ton.org/mcp"
    }
  }
}

MCP 工具

工具必需参数描述
search_ton_docsquery在 TON Docs 知识库中搜索相关内容、代码示例、API 参考和指南
get_page_ton_docspage根据路径获取特定文档页面的完整内容(例如,从搜索结果中获取)

使用场景

  • 用户询问 TON 区块链概念(工作链、分片、验证者、主链)
  • 用户询问智能合约开发(FunC、Tact、Tolk、Fift、TL-B 架构)
  • 用户询问 TON 标准(TEP、jetton 标准 TEP-74、NFT 标准 TEP-62)
  • 用户询问钱包合约、消息格式或内部/外部消息
  • 用户询问 TON 地址、BOC 编码、单元序列化
  • 用户询问 TON 上的 DeFi 协议、DEX 或代币机制
  • 用户需要 TON 智能合约或 SDK 用法的代码示例
  • 用户询问 TON API(TonCenter v2/v3)、节点操作或基础设施

工作流

  1. 从用户的问题中确定主题及其子方面
  2. 使用不同的目标查询多次调用 search_ton_docs,以覆盖所有角度(例如,一次宽泛查询加一次针对 SDK/工具的查询)
  3. 从合并后的搜索结果中,找出 2–4 个最相关的页面路径
  4. 并行调用这些页面的 get_page_ton_docs,以高效获取完整内容
  5. 如果页面引用了其他相关页面(例如“另请参阅”部分),也获取这些页面
  6. 综合所有获取的页面内容来组织答案,包含代码示例,并链接到来源(在路径前添加 https://docs.ton.org/)

注意事项

  • 搜索结果只返回简短摘要——务必继续调用 get_page_ton_docs,以获取包含代码示例的完整页面内容
  • 搜索结果中的页面路径可直接传给 get_page_ton_docs,无需修改
  • 通常需要获取 3–5 个页面才能给出良好答案;单个页面很少能涵盖全部内容
  • 对于智能合约问题,在提供示例前,先确定用户使用的是 FunC、Tact 还是 Tolk
  • 对于 SDK 问题,先确定语言(例如,使用 @ton/ton 的 TypeScript/JavaScript、使用 pytoniq 的 Python 等)
  • TON 文档会定期更新——务必搜索最新内容,不要依赖缓存的知识

TEP(TON 增强提案)

对于文档网站未涵盖的协议标准,可在 GitHub 上查阅 TEP:

TEP主题URL
TEP-62NFT 标准https://github.com/ton-blockchain/TEPs/blob/master/text/0062-nft-standard.md
TEP-64代币数据标准https://github.com/ton-blockchain/TEPs/blob/master/text/0064-token-data-standard.md
TEP-74Jetton 标准https://github.com/ton-blockchain/TEPs/blob/master/text/0074-jettons-standard.md
TEP-81DNS 标准https://github.com/ton-blockchain/TEPs/blob/master/text/0081-dns-standard.md
所有 TEP索引https://github.com/ton-blockchain/TEPs/blob/master/README.md

评论

支持 Markdown