modelcontextprotocol / modelcontextprotocol/python-sdk

Replace Field(description=...) with proper docstrings in auth models

Đang mở
#2,053 1 bình luận 0 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

auth enhancement v2
Ngôn ngữ chính
Python
Star
24.3k
Fork
4k
Merge trung bình
1 ngày 1 giờ
Pull request đã merge (30 ngày)
31

Mô tả

From the V2 checklist in #1253 (under "Refactor the auth way of using it"):

Drop the use of Field(description=...), and use proper docstrings. As far as I know, we are not creating json schemas from it, so it's useless.

The auth-related Pydantic models currently use Field(description=...) to document fields. Since we are not generating JSON schemas from these models, the descriptions are not surfaced anywhere useful. They should be replaced with standard Python docstrings that are more discoverable via IDEs and help().

This is part of the broader auth refactor planned for V2.

Ref: Kludex's V2 checklist in #1253

Hướng dẫn đóng góp

Mở hướng dẫn đóng góp

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Hướng nghiên cứu

Bắt đầu bằng cách xác định các model Pydantic liên quan đến auth sử dụng Field(description=...), sau đó xem lại checklist V2 trong #1253 để biết phạm vi dự kiến. Thay thế các mô tả field đó bằng docstring Python tiêu chuẩn và xác minh rằng tất cả các model auth mục tiêu không còn sử dụng mẫu tài liệu này.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Đánh giá

Công nghệ
python
Lĩnh vực
authentication
Loại issue
Tái cấu trúc
Độ khó
3/5
Thời gian dự kiến
1-2 ngày
Mức độ hoạt động
Ít trao đổi
Độ rõ ràng
Khá rõ ràng
Mức phù hợp với người mới
52/100

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.