fastmcp/examples/auth/huggingface_oauth
Jeremiah Lowin 7d76c9d055
Add examples/ to the ty static-analysis gate (#4466)
* Add examples/ to ty static-analysis gate

* Fix example type errors and stale SDK idioms for ty

* Use typing_extensions.TypedDict for the quiz tool-param type

Question is a take_quiz parameter, so FastMCP builds a Pydantic schema
for it; typing.TypedDict raises PydanticUserError on Python 3.10/3.11
(only 3.12+ accepts it). ty and 3.12 runs miss this, so it slipped in.

* Guard get_access_token() None case in huggingface_oauth example

Caught by the ty gate this PR adds: the example, merged separately,
had never been type-checked against examples/. Matches the existing
aws_oauth/keycloak_oauth pattern.

* Print actual YAML text in custom serializer example
2026-07-18 19:44:13 -04:00
..
client.py Forward-port Hugging Face auth provider (#4475) 2026-07-08 20:56:07 -04:00
README.md Forward-port Hugging Face auth provider (#4475) 2026-07-08 20:56:07 -04:00
server.py Add examples/ to the ty static-analysis gate (#4466) 2026-07-18 19:44:13 -04:00

Hugging FAce OAuth Example

Demonstrates FastMCP server protection with Hugging Face OAuth.

Setup

  1. Create a Hugging Face OAuth App:

    • Go to Hugging Face Settings > Connected Apps > Create App (https://huggingface.co/settings/applications/new)
    • Set Authorization callback URL to: http://localhost:8000/auth/callback
    • Copy the Client ID and Client Secret
  2. Set environment variables:

    export FASTMCP_SERVER_AUTH_HF_CLIENT_ID="your-client-id"
    export FASTMCP_SERVER_AUTH_HF_CLIENT_SECRET="your-client-secret"
    
  3. Run the server:

    python server.py
    
  4. In another terminal, run the client:

    python client.py
    

The client will open your browser for Hugging Face authentication.