{
  "schema_version": "1.1",
  "docs_version": "a2bc6a0f021ec643",
  "name": "Plan A HR Agent Portal",
  "base_url": "https://sandbox.maimai.dev.planahr.top",
  "html_url": "https://sandbox.maimai.dev.planahr.top/agent/",
  "instructions_url": "https://sandbox.maimai.dev.planahr.top/api/v1/agent/guide",
  "full_reference_url": "https://sandbox.maimai.dev.planahr.top/agent/reference.md",
  "transport": "http-json-tools",
  "authentication_required_for_docs": false,
  "environment": "sandbox",
  "identity_provider_mode": "simulated-feishu",
  "synthetic_only": true,
  "auth": {
    "provider": "feishu",
    "flow": "device_authorization",
    "device_authorization_endpoint": "https://sandbox.maimai.dev.planahr.top/api/v1/agent-auth/device",
    "token_endpoint": "https://sandbox.maimai.dev.planahr.top/api/v1/agent-auth/token",
    "device_grant_type": "urn:ietf:params:oauth:grant-type:device_code",
    "public_client_profile": "planahr-agent",
    "agent_name_parameter": "agent_name",
    "requested_business_scope_parameter": "scope",
    "default_business_scopes": [
      "candidates:read",
      "jobs:read",
      "clients:read",
      "hiring:read"
    ],
    "business_scope_response_field": "business_scope",
    "management_url": "https://sandbox.maimai.dev.planahr.top/#agent-authorizations",
    "client_secret_required": false
  },
  "invocation": {
    "schema_method": "GET",
    "invoke_method": "POST",
    "authorization_header": "Authorization: Bearer <access_token>",
    "content_type": "application/json",
    "body": {
      "operation": "<tool name without module prefix>",
      "input": "<object matching inputSchema>"
    },
    "schema_query": {
      "operation": "<operation name>"
    },
    "summary_query": {
      "view": "summary"
    }
  },
  "modules": [
    {
      "id": "candidates",
      "name": "候选人库",
      "endpoint": "https://sandbox.maimai.dev.planahr.top/api/v1/candidate-library/tools",
      "tool_prefix": "candidate_library_",
      "read_scope": "candidates:read",
      "write_scope": "candidates:write",
      "operations": [
        "search",
        "detail",
        "contacts",
        "notes",
        "documentInfo",
        "documents",
        "resumeContent",
        "duplicates",
        "create",
        "update",
        "note"
      ],
      "reference_url": "https://sandbox.maimai.dev.planahr.top/agent/references/candidates.md"
    },
    {
      "id": "jobs",
      "name": "岗位",
      "endpoint": "https://sandbox.maimai.dev.planahr.top/api/v1/job-library/tools",
      "tool_prefix": "job_library_",
      "read_scope": "jobs:read",
      "write_scope": "jobs:write",
      "operations": [
        "companies",
        "search",
        "detail",
        "create",
        "update"
      ],
      "reference_url": "https://sandbox.maimai.dev.planahr.top/agent/references/jobs.md"
    },
    {
      "id": "clients",
      "name": "客户公司",
      "endpoint": "https://sandbox.maimai.dev.planahr.top/api/v1/client-library/tools",
      "tool_prefix": "client_library_",
      "read_scope": "clients:read",
      "write_scope": "clients:write",
      "operations": [
        "search",
        "detail",
        "create",
        "update"
      ],
      "reference_url": "https://sandbox.maimai.dev.planahr.top/agent/references/clients.md"
    },
    {
      "id": "hiring",
      "name": "招聘流程",
      "endpoint": "https://sandbox.maimai.dev.planahr.top/api/v1/hiring/tools",
      "tool_prefix": "hiring_",
      "read_scope": "hiring:read",
      "write_scope": "hiring:write",
      "operations": [
        "read",
        "create",
        "transition",
        "assign",
        "collaborate",
        "note",
        "event",
        "jobState",
        "jobAssign",
        "candidatePolicy",
        "candidateAssign",
        "resolveImport",
        "personalNote"
      ],
      "reference_url": "https://sandbox.maimai.dev.planahr.top/agent/references/hiring.md"
    }
  ],
  "references": {
    "auth": "https://sandbox.maimai.dev.planahr.top/agent/references/auth.md",
    "candidates": "https://sandbox.maimai.dev.planahr.top/agent/references/candidates.md",
    "jobs": "https://sandbox.maimai.dev.planahr.top/agent/references/jobs.md",
    "clients": "https://sandbox.maimai.dev.planahr.top/agent/references/clients.md",
    "hiring": "https://sandbox.maimai.dev.planahr.top/agent/references/hiring.md",
    "recovery": "https://sandbox.maimai.dev.planahr.top/agent/references/recovery.md"
  },
  "sensitive_scopes": [
    "sensitive:contacts",
    "sensitive:notes",
    "sensitive:documents"
  ],
  "binary_endpoints": [
    {
      "method": "POST",
      "path": "/api/v1/candidate-library/{id}/documents",
      "content_type": "multipart/form-data",
      "file_field": "file",
      "scope": "candidates:write"
    },
    {
      "method": "GET",
      "path": "/api/v1/candidate-library/{id}/documents/{documentId}",
      "scopes": [
        "candidates:read",
        "sensitive:documents"
      ]
    }
  ],
  "not_exposed": [
    "maimai_search_and_send",
    "connector_cookies",
    "system_administration",
    "member_transfers",
    "native_mcp_transport"
  ]
}