FastMCP 项目使用教程

FastMCP 项目使用教程

fastmcp The fast, Pythonic way to build Model Context Protocol servers 🚀 项目地址: https://gitcode.com/gh_mirrors/fa/fastmcp

1. 项目的目录结构及介绍

FastMCP 项目是一个用于构建 Model Context Protocol (MCP) 服务器的 Python 库。以下是项目的目录结构及其简要介绍：

• assets/: 存储项目相关的静态资源文件，如图标、图片等。
• docs/: 包含项目文档的Markdown文件。
• examples/: 提供了一些 FastMCP 的使用示例。
• src/: 包含 FastMCP 的源代码。
  • fastmcp/: FastMCP 库的核心代码。
• tests/: 存储项目的单元测试代码。
• .gitignore: 指定git忽略的文件和目录。
• LICENSE: 项目使用的许可证文件。
• README.md: 项目说明文件。
• Windows_Notes.md: 针对Windows用户的特别说明。
• pyproject.toml: 项目配置文件。
• uv.lock: 用于记录 uv 库的版本。

2. 项目的启动文件介绍

项目的启动文件通常是 src/fastmcp/__init__.py。此文件初始化了 FastMCP 库，并提供了创建 MCP 服务器的入口点。以下是启动文件的一个基本示例：

# src/fastmcp/__init__.py
from .server import FastMCP

# 导出 FastMCP 类以便用户可以直接使用
__all__ = ["FastMCP"]

用户可以通过以下方式创建一个简单的 MCP 服务器：

from fastmcp import FastMCP

mcp = FastMCP("My App")

然后，可以添加工具、资源和提示来丰富服务器功能。

3. 项目的配置文件介绍

项目的配置文件是 pyproject.toml，它用于定义项目的元数据和依赖项。以下是配置文件的一个基本示例：

[build-system]
requires = ["setuptools", "wheel"]
build-backend = "setuptools.build_meta"

[tool.setuptools]
name = "fastmcp"
version = "0.1.0"
description = "The fast, Pythonic way to build Model Context Protocol servers"
long_description = "..."
author = "jlowin"
author_email = "..."
url = "..."
classifiers = [
    "Programming Language :: Python :: 3",
    "License :: OSI Approved :: MIT License",
    # 其他分类...
]

[dependencies]
# 列出项目运行所需的依赖
uv = "0.17.0"
httpx = "0.23.0"
pydantic = "1.10.0"
PIL = "9.0.0"

在 pyproject.toml 文件中，可以定义项目的名称、版本、作者、依赖项等信息。这些信息在安装和打包项目时会被使用。

请确保在使用前正确配置和安装所有必要的依赖项。

fastmcp The fast, Pythonic way to build Model Context Protocol servers 🚀 项目地址: https://gitcode.com/gh_mirrors/fa/fastmcp