MCP服务构建工具

一个快速、Pythonic的方式来构建MCP服务器和客户端的工具,支持国际化文档管理。

  • by Gu-f
  • MDX
  • 本地部署
  • 2 星标
  • 更新于
在 GitHub 查看 Gu-f/FastmcpDocs

使用说明

FastmcpDocs

I18N
The internationalized documentation of fastmcp.

🚀 The fast, Pythonic way to build MCP servers and clients.

fastmcp source code

Folder description

i18n: Internationalized document.
origin: Original comparison document.(The fastmcp does not have an i18n structure. This folder is used to facilitate the comparison with the original content.)

Contributions

  1. Usually, you need to perform a diff operation with the original document, Make sure the document is up-to-date.
  2. Then, create the corresponding language configuration file in the i18n/json_config directory, and translate the parts that need to be translated in the language configuration file.
  3. Create a folder named with the corresponding LANGUAGE CODE in the i18n directory, and name the file as the corresponding CODE. The CODE can be referred to in the table LANGUAGE_CODE
  4. Create a copy of origin or i18n/en. If you use origin as the source for the copy, be sure to maintain the correctness of the file structure.
  5. Use the command cd i18n to enter the directory i18n, and then use the script python build_docs_json.py to update the file i18n/docs.json.
  6. Start the translation process and use mint dev to check the accuracy of the translation at any time.(Regarding the installation and usage of Mint, please refer to Document MintlifyDocs.)
  7. Submit your internationalized content.

FastmcpDocs

I18N
fastmcp国际化文档。

🚀 构建 MCP 服务端和客户端更快捷,更Pythonic的方式.

文件夹叙述

i18n: 国际化后的文档.
origin: 原始对照文档.(fastmcp没有i18n结构化,该文件夹用于方便与原始内容进行diff)

贡献

  1. 通常你需要先与原始文档进行diff操作,确保文档是最新的。
  2. 然后在i18n/json_config目录下创建对应的语言配置文件,并将其语言配置文件中需要翻译的部分进行翻译。
  3. 在i18n目录创建对应语言的LANGUAGE CODE文件夹,文件名为对应的CODE,CODE可以参考该表格LANGUAGE_CODE
  4. 创建origin或i18n/en的拷贝,如果你使用origin为源进行拷贝,注意文件结构的正确性。
  5. 使用命令cd i18n进入目录i18n,然后使用脚本python build_docs_json.py更新i18n/docs.json文件。
  6. 开始进行翻译,并随时使用mint dev检查翻译正确性。(关于mint的安装和使用参考文档MintlifyDocs进行)。
  7. 提交你的国际化内容。