Issuebage MCP Server

chính thức

nền tảng cấp huy hiệu kỹ thuật số

Tài liệu

IssueBadge MCP Server

Một máy chủ Model Context Protocol (MCP) để tương tác với API IssueBadge. Máy chủ này cho phép các trợ lý AI như Claude và ChatGPT quản lý huy hiệu số và chứng chỉ bằng ngôn ngữ tự nhiên.

🌟 Tính năng

🤖 Quản lý huy hiệu bằng AI: Sử dụng ngôn ngữ tự nhiên để tạo, cấp phát và quản lý huy hiệu
🔐 Xác thực kép: Hỗ trợ cả Laravel Sanctum và OAuth2
🏆 Vòng đời huy hiệu đầy đủ: Tạo mẫu, cấp cho người nhận và xác minh tính xác thực
📊 Hỗ trợ đa người thuê: Cô lập người thuê an toàn cho doanh nghiệp
🛡️ Bảo vệ lũy đẳng: Ngăn chặn thao tác trùng lặp với các biện pháp bảo vệ tích hợp
📧 Thông báo tự động: Tự động gửi email với URL xác minh
🎨 Trường tùy chỉnh: Hỗ trợ siêu dữ liệu linh hoạt và trường tùy chỉnh

🚀 Bắt đầu nhanh

Điều kiện tiên quyết

Node.js 18+
npm 8+
Tài khoản IssueBadge API với khóa API

Cài đặt

Sao chép kho lưu trữ

git clone https://github.com/issuebadge/mcp-server.git
cd mcp-server

Cài đặt phụ thuộc
```
npm install
```

Cấu hình môi trường

cp .env.example .env
# Edit .env with your IssueBadge API credentials

Xây dựng dự án
```
npm run build
```
Kiểm tra máy chủ
```
npm test
```

⚙️ Cấu hình

Tạo tệp .env dựa trên .env.example:

# API Configuration
ISSUEBADGE_BASE_URL=https://app.issuebadge.com/api/v1
ISSUEBADGE_API_KEY=

# OAuth2 Configuration (Alternative)
ISSUEBADGE_OAUTH_URL=https://app.issuebadge.com/api/v1/oauth
ISSUEBADGE_OAUTH_TOKEN=your_oauth_token_here

# Authentication Method (sanctum or oauth2)
AUTH_METHOD=sanctum

# Server Configuration
MCP_SERVER_NAME=IssueBadge MCP Server
MCP_SERVER_VERSION=1.0.0

# Optional Settings
REQUEST_TIMEOUT=30000
DEBUG=false
MAX_RETRIES=3
RETRY_DELAY=1000

🔧 Tích hợp

Claude Desktop

Thêm máy chủ này vào cấu hình Claude Desktop của bạn:

{
  "mcpServers": {
    "issuebadge": {
      "command": "node",
      "args": ["/absolute/path/to/mcp-server/dist/index.js"],
      "env": {
        "ISSUEBADGE_BASE_URL": "https://app.issuebadge.com
/api/v1",
        "ISSUEBADGE_API_KEY": "",
        "AUTH_METHOD": "sanctum"
      }
    }
  }
}

ChatGPT Actions

Tạo một Custom GPT mới trong ChatGPT
Nhập đặc tả OpenAPI từ phiên bản IssueBadge của bạn
Cấu hình xác thực Bearer token với khóa API của bạn
Bắt đầu quản lý huy hiệu qua hội thoại!

🛠️ Công cụ có sẵn

1. `validate_key`

Xác thực khóa API IssueBadge để xác thực.

Tham số:

api_key (chuỗi, bắt buộc): Khóa API cần xác thực

Ví dụ:

"Validate my API key: 1|abcdef123456789..."

2. `get_all_badges`

Lấy tất cả huy hiệu có sẵn cho tổ chức đã xác thực.

Tham số:

limit (số, tùy chọn): Số huy hiệu tối đa trả về (mặc định: 100)

Ví dụ:

"Show me all available badges"
"List the first 50 badges"

3. `create_badge`

Tạo mẫu huy hiệu mới với các trường tùy chỉnh tùy chọn.

Tham số:

name (chuỗi, bắt buộc): Tên huy hiệu
description (chuỗi, bắt buộc): Mô tả huy hiệu
issuing_organization_name (chuỗi, bắt buộc): Tên tổ chức
idempotency_key (chuỗi, bắt buộc): Định danh duy nhất
custom_fields (mảng, tùy chọn): Định nghĩa trường tùy chỉnh
Và nhiều tham số tùy chọn khác...

Ví dụ:

"Create a badge called 'Web Development Certificate' for completing our full-stack course"
"Create a Python certification badge with custom fields for completion date and final score"

4. `issue_badge`

Cấp huy hiệu cho người nhận với siêu dữ liệu tùy chọn.

Tham số:

badge_id (chuỗi, bắt buộc): ID huy hiệu từ lúc tạo
name (chuỗi, bắt buộc): Tên đầy đủ của người nhận
idempotency_key (chuỗi, bắt buộc): Định danh duy nhất
email (chuỗi, tùy chọn): Email của người nhận
metadata (đối tượng, tùy chọn): Giá trị trường tùy chỉnh

Ví dụ:

"Issue the Web Development badge to John Doe with email [email protected]"
"Issue Python certification to Alice with completion date today and score 95%"

💬 Ví dụ ngôn ngữ tự nhiên

Tạo huy hiệu

Human: "Create a badge for JavaScript mastery with fields for completion date and project count"

AI: I'll create a JavaScript mastery badge with the custom fields you specified.

✨ Badge Created Successfully!
🏷️ Badge Name: JavaScript Mastery Certificate
🆔 Badge ID: js_mastery_2024_001
📋 Custom fields: completion_date (date), project_count (number)

Cấp huy hiệu

Human: "Issue the JavaScript badge to Sarah Chen with completion date December 1st and 5 projects completed"

AI: I'll issue the JavaScript mastery badge to Sarah Chen with the specified details.

🎉 Badge Issued Successfully!
📧 Recipient: Sarah Chen  
🔗 Verification URL: https://yourdomain.com/verify/xyz123
📅 Completion Date: 2024-12-01
📊 Projects: 5

Thao tác hàng loạt

Human: "Create completion badges for all students in my Python course who scored above 85%"

AI: I'll help you create and issue completion badges for high-performing students. First, let me create a Python Course Completion badge, then we can issue it to qualified students.

[Creates badge and processes student list]

🏗️ Phát triển

Xây dựng từ mã nguồn

# Clone the repository
git clone https://github.com/issuebadge/mcp-server.git
cd mcp-server

# Install dependencies
npm install

# Build TypeScript
npm run build

# Run in development mode
npm run dev

# Lint code
npm run lint

# Format code
npm run format

Cấu trúc dự án

mcp-server/
├── src/
│   └── index.ts          # Main MCP server implementation
├── dist/                 # Compiled JavaScript (generated)
├── .env.example         # Environment configuration template
├── package.json         # Node.js dependencies and scripts
├── tsconfig.json        # TypeScript configuration
└── README.md           # This file

🔒 Bảo mật

Tất cả giao tiếp API sử dụng HTTPS
Khóa API được xác thực trước mỗi yêu cầu
Khóa lũy đẳng ngăn chặn thao tác trùng lặp
Cô lập dữ liệu đa người thuê
Bảo vệ thời gian chờ yêu cầu
Xử lý lỗi toàn diện

📊 Xử lý lỗi

Máy chủ MCP cung cấp thông báo lỗi chi tiết cho các vấn đề phổ biến:

Lỗi xác thực: Khóa API không hợp lệ hoặc token hết hạn
Lỗi xác thực dữ liệu: Thiếu tham số bắt buộc hoặc định dạng không hợp lệ
Lỗi mạng: Thời gian chờ kết nối hoặc dịch vụ không khả dụng
Lỗi logic nghiệp vụ: Thao tác trùng lặp hoặc không đủ quyền

🌍 Trường hợp sử dụng

Cơ sở giáo dục

Hoàn thành khóa học: Tự động cấp huy hiệu khi học viên hoàn thành khóa học
Xác thực kỹ năng: Tạo huy hiệu dựa trên kỹ năng với điểm đánh giá
Chứng chỉ tốt nghiệp: Cấp hàng loạt huy hiệu tốt nghiệp với chi tiết học thuật

Đào tạo doanh nghiệp

Chương trình chứng nhận: Quản lý chứng nhận chuyên nghiệp với ngày hết hạn
Đào tạo tuân thủ: Theo dõi và xác minh hoàn thành đào tạo bắt buộc
Phát triển kỹ năng: Cấp huy hiệu cho chương trình phát triển kỹ năng nội bộ

Quản lý sự kiện

Tham dự hội nghị: Cấp huy hiệu tham dự cho sự kiện và hội thảo
Theo dõi thành tích: Tạo hệ thống huy hiệu tiến bộ cho chương trình đang diễn ra
Công nhận diễn giả: Quản lý huy hiệu công nhận diễn giả và người tham gia

🤝 Đóng góp

Chúng tôi hoan nghênh đóng góp! Vui lòng xem hướng dẫn đóng góp của chúng tôi:

Fork kho lưu trữ
Tạo nhánh tính năng: git checkout -b feature/amazing-feature
Commit thay đổi: git commit -m 'Add amazing feature'
Đẩy lên nhánh: git push origin feature/amazing-feature
Mở Pull Request

Hướng dẫn phát triển

Tuân thủ thực hành tốt nhất của TypeScript
Thêm xử lý lỗi toàn diện
Bao gồm chú thích JSDoc cho hàm
Cập nhật kiểm thử cho tính năng mới
Tuân thủ phiên bản ngữ nghĩa

📝 Giấy phép

Dự án này được cấp phép theo Giấy phép MIT - xem tệp LICENSE để biết chi tiết.

🆘 Hỗ trợ

Nhận trợ giúp

📖 Tài liệu: Kiểm tra README này và chú thích mã nội tuyến
🐛 Báo cáo lỗi: Mở issue
💬 Thảo luận: GitHub Discussions
📧 Email: [email protected]

Khắc phục sự cố

Vấn đề phổ biến

1. Xác thực khóa API thất bại

# Check API key format (should start with number|)
# Verify the key hasn't expired
# Ensure correct base URL

2. Thời gian chờ kết nối

# Check network connectivity
# Verify IssueBadge service status
# Increase REQUEST_TIMEOUT in .env

3. Lỗi tạo huy hiệu

# Verify required fields are provided
# Check idempotency key uniqueness
# Validate organization permissions

🔗 Dự án liên quan

IssueBadge API: Nền tảng quản lý huy hiệu cốt lõi
Model Context Protocol: Đặc tả và công cụ MCP
Claude Desktop: Trợ lý AI hỗ trợ MCP

📈 Lộ trình

Phiên bản 1.1

Thao tác huy hiệu hàng loạt
Lọc và tìm kiếm nâng cao
Tích hợp webhook
Quản lý mẫu huy hiệu

Phiên bản 1.2

Công cụ phân tích và báo cáo
Quy tắc xác thực huy hiệu tùy chỉnh
Tích hợp với hệ thống quản lý học tập
Tự động hóa quy trình nâng cao

Phiên bản 2.0

Hỗ trợ xác minh blockchain
Nội dung huy hiệu đa ngôn ngữ
Tùy chỉnh thương hiệu nâng cao
Tích hợp SSO doanh nghiệp

Sẵn sàng cách mạng hóa quản lý huy hiệu của bạn? Bắt đầu với IssueBadge MCP Server và trải nghiệm sức mạnh của quản trị huy hiệu bằng hội thoại!

Được xây dựng với ❤️ bởi đội ngũ IssueBadge

Issuebage MCP Server

Tài liệu

IssueBadge MCP Server

🌟 Tính năng

🚀 Bắt đầu nhanh

Điều kiện tiên quyết

Cài đặt

⚙️ Cấu hình

🔧 Tích hợp

Claude Desktop

ChatGPT Actions

🛠️ Công cụ có sẵn

1. validate_key

2. get_all_badges

3. create_badge

4. issue_badge

💬 Ví dụ ngôn ngữ tự nhiên

Tạo huy hiệu

Cấp huy hiệu

Thao tác hàng loạt

🏗️ Phát triển

Xây dựng từ mã nguồn

Cấu trúc dự án

🔒 Bảo mật

📊 Xử lý lỗi

🌍 Trường hợp sử dụng

Cơ sở giáo dục

Đào tạo doanh nghiệp

Quản lý sự kiện

🤝 Đóng góp

Hướng dẫn phát triển

📝 Giấy phép

🆘 Hỗ trợ

Nhận trợ giúp

Khắc phục sự cố

Vấn đề phổ biến

🔗 Dự án liên quan

📈 Lộ trình

Phiên bản 1.1

Phiên bản 1.2

Phiên bản 2.0

1. `validate_key`

2. `get_all_badges`

3. `create_badge`

4. `issue_badge`