mcp服务器检查
⚠️ 早期访问测试版 --此MCP服务器目前处于测试阶段,可供部分合作伙伴使用。API、工具和行为可能会更改,恕不另行通知。请与您的检查联系人分享反馈。
服务条款 -通过使用此MCP服务器访问Check API,您同意 MCP使用条款,这是您与Check现有协议的补充。
一 主控程序 包装的服务器 检查工资API,为管理公司、员工、承包商、工资单、税务配置、嵌入式组件等提供263个工具。
快速启动
git clone https://github.com/check-technologies/mcp-server-check.git
cd mcp-server-check
uv sync
CHECK_API_KEY=your-key uv run mcp-server-check配置
| 环境变量 | 必填 | 默认 | 描述 |
|---|---|---|---|
CHECK_API_KEY | 是 | - | 您的Check API密钥(承载令牌) |
CHECK_API_BASE_URL | 没有 | https://sandbox.checkhq.com | API基本URL |
CHECK_TOOL_MODE | 没有 | dynamic | 刀具模式: dynamic (3个元工具)或 all (所有工具单独) |
CHECK_TOOLSETS | 否 | -- | 要启用的工具集逗号分隔列表(例如。 companies,employees) |
CHECK_TOOLS | 否 | -- | 逗号分隔的单个工具名称列表 |
CHECK_EXCLUDE_TOOLS | 没有 | -- | 要隐藏的逗号分隔的工具名称列表 |
CHECK_READ_ONLY | 否 | -- | 设置为 1, true,或 yes 禁用所有写入/修改工具 |
CHECK_TRANSPORT | 没有 | stdio | 传输协议: stdio, sse,或 streamable-http |
沙盒vs生产
默认情况下,服务器连接到 检查沙盒 (https://sandbox.checkhq.com),这对测试和开发是安全的。沙箱支持模拟端点(例如。 simulate_start_processing, simulate_complete_funding)这让你在没有实际资金流动的情况下,通过处理州提前发放工资。
要指向生产,请设置:
CHECK_API_BASE_URL=https://api.checkhq.com服务器配置
服务器支持细粒度的工具过滤,可通过环境变量(用于stdio)或HTTP标头(用于SSE/可流式传输的HTTP)进行配置。以下是 .
| 特性 | 环境变量 | HTTP标头 |
|---|---|---|
| 工具集 | CHECK_TOOLSETS | X-MCP-Toolsets |
| 个人工具 | CHECK_TOOLS | X-MCP-Tools |
| 排除工具 | CHECK_EXCLUDE_TOOLS | X-MCP-Exclude-Tools |
| 只读 | CHECK_READ_ONLY | X-MCP-Readonly |
筛选优先级: exclude_tools > read_only > tools > toolsets排除总是赢;如果 tools 它作为一个独立于工具集的列表。
工具集
共有17个工具集,每个API模块一个: bank_accounts, companies, compensation, components, contractor_payments, contractors, documents, employees, external_payrolls, forms, payments, payroll_items, payrolls, platform, tax, webhooks, workplaces.
仅启用特定的工具集:
CHECK_TOOLSETS=companies,employees CHECK_API_KEY=your-key uv run mcp-server-check个人工具
只允许按名称列出特定工具:
CHECK_TOOLS=list_companies,get_company,list_employees CHECK_API_KEY=your-key uv run mcp-server-check不包括工具
隐藏特定工具,同时保留其他所有内容:
CHECK_EXCLUDE_TOOLS=create_company,delete_company CHECK_API_KEY=your-key uv run mcp-server-check只读模式
集 CHECK_READ_ONLY=1 仅使用只读工具(列表、获取、下载、预览等)运行服务器。所有创建、更新、删除和其他变异工具都被排除在外。当您希望在没有修改风险的情况下探索Check数据时,这很有用。
CHECK_READ_ONLY=1 CHECK_API_KEY=your-key uv run mcp-server-checkHTTP标头(远程传输)
跑步时 CHECK_TRANSPORT=sse 或 CHECK_TRANSPORT=streamable-http,客户端可以通过HTTP标头传递配置:
X-MCP-Toolsets: companies,employees
X-MCP-Readonly: true
X-MCP-Exclude-Tools: create_company,delete_company当标头提供任何筛选器设置时,基于标头的配置优先于环境变量。
动态工具模式(默认)
默认情况下,服务器以动态模式运行(CHECK_TOOL_MODE=dynamic),公开3个元工具,而不是所有单独的工具。这避免了将每个工具模式预先发送到LLM,节省了大量的上下文窗口空间。
search_tools(query, toolset?, limit?)--通过同义词匹配的关键字搜索工具。返回具有完整参数模式的匹配工具。list_toolsets()--列出所有可用的工具集,并附上说明和示例工具。run_tool(tool_name, arguments?)--使用参数字典按名称执行工具。
LLM工作流变为:浏览工具集或搜索相关工具→ 查看他们的参数模式→ call run_tool 用正确的论据。全部筛选(CHECK_TOOLSETS, CHECK_READ_ONLY等等)在搜索层和执行层都应用。
集 CHECK_TOOL_MODE=all 单独公开所有工具(传统模式):
CHECK_TOOL_MODE=all CHECK_API_KEY=your-key uv run mcp-server-check使用Claude Desktop
添加到您的 claude_desktop_config.json:
{
"mcpServers": {
"check": {
"command": "uv",
"args": ["run", "--directory", "/path/to/mcp-server-check", "mcp-server-check"],
"env": {
"CHECK_API_KEY": "your-api-key"
}
}
}
}使用Claude代码
claude mcp add check -- uv run --directory /path/to/mcp-server-check mcp-server-check然后设置 CHECK_API_KEY 在运行Claude Code之前,先在shell中设置环境变量。
可用工具
263个工具,分为17个类别。所有列表工具支持 limit 和 cursor 基于光标的分页参数--传递 cursor 从上一个响应中获取值以获取下一页。
公司(26种工具)
| 工具 | 方法 | 说明 |
|---|---|---|
list_companies | GET | 列出具有可选筛选器的公司 |
get_company | 获取特定公司的详细信息 | |
create_company | POST | 创建新公司 |
update_company | PATCH | 更新现有公司 |
onboard_company | POST | 让公司进入活跃状态 |
get_company_paydays | 获取 | 获取公司即将到来的发薪日 |
list_company_tax_deposits | GET | 列出公司的税收存款 |
get_company_benefit_aggregations | GET | 获取公司的福利汇总 |
get_payroll_journal_report | GET | 获取工资日记账报告 |
get_payroll_summary_report | GET | 获取工资汇总报告 |
get_tax_liabilities_report | GET | 获取税务负债报告 |
get_contractor_payments_report | GET | 获取承包商付款报告 |
get_child_support_payments_report | GET | 获取子女抚养费报告 |
get_w4_exemption_status_report | GET | 获取W-4豁免状态报告 |
get_applied_for_ids_detailed_report | GET | 获取ID申请详细报告 |
get_w2_preview_report | GET | 获取W-2预览报告 |
list_federal_ein_verifications | GET | 列出联邦EIN验证 |
get_federal_ein_verification | GET | 获取特定的EIN验证 |
list_signatories | GET | 列出公司的签署人 |
create_signatory | POST | 创建签名人 |
get_enrollment_profile | GET | 获取注册资料 |
create_enrollment_profile | PUT | 创建注册档案 |
update_enrollment_profile | PATCH | 更新注册资料 |
start_implementation | POST | 开始为公司实施 |
cancel_implementation | POST | 取消实施 |
request_embedded_setup | POST | 请求嵌入式设置 |
员工(17工具)
| 工具 | 方法 | 说明 |
|---|---|---|
list_employees | GET | 列出具有可选筛选器的员工 |
get_employee | 获取特定员工的详细信息 | |
create_employee | POST | 创建新员工 |
update_employee | PATCH | 更新现有员工 |
onboard_employee | POST | 将员工入职为活跃状态 |
list_employee_paystubs | GET | 列出员工的工资单 |
get_employee_paystub | GET | 获取特定的工资条 |
list_employee_forms | GET | 列出员工的表单 |
get_employee_form | GET | 获取特定员工表格 |
submit_employee_form | POST | 提交员工表格 |
sign_and_submit_employee_form | POST | 签署并提交员工表格 |
get_employee_company_defined_attributes | GET | 获取公司定义的属性 |
update_employee_company_defined_attributes | PATCH | 更新公司定义的属性 |
get_employee_reciprocity_elections | GET | 获得互惠选举 |
update_employee_reciprocity_elections | PATCH | 更新互惠选举 |
reveal_employee_ssn | 获取 | 显示员工SSN |
authorize_employee_partner | POST | 为员工授权合作伙伴 |
承包商(10个工具)
| 工具 | 方法 | 说明 |
|---|---|---|
list_contractors | GET | 列出具有可选筛选器的承包商 |
get_contractor | 获取特定承包商的详细信息 | |
create_contractor | POST | 创建新承包商 |
update_contractor | PATCH | 更新现有承包商 |
onboard_contractor | POST | 让承包商进入活动状态 |
list_contractor_payments_for_contractor | GET | 列出承包商的付款 |
get_contractor_payment_for_payroll | GET | 获取承包商工资单付款 |
list_contractor_forms | GET | 承包商列表表格 |
submit_contractor_form | POST | 提交承包商表格 |
reveal_contractor_ssn | 获取 | 披露承包商SSN/EIN |
工作场所(4个工具)
| 工具 | 方法 | 说明 |
|---|---|---|
list_workplaces | GET | 列出工作场所 |
get_workplace | 获取特定工作场所的详细信息 | |
create_workplace | POST | 创建新的工作场所 |
update_workplace | PATCH | 更新现有工作区 |
工资单(15个工具)
| 工具 | 方法 | 说明 |
|---|---|---|
list_payrolls | GET | 列出带有可选过滤器的工资单 |
get_payroll | GET | 获取特定工资单的详细信息 |
create_payroll | POST | 创建新的工资单 |
update_payroll | PATCH | 更新现有工资单 |
delete_payroll | DELETE | 删除工资单 |
preview_payroll | GET | 批准前预览工资单 |
approve_payroll | POST | 批准工资单以供处理 |
reopen_payroll | POST | 重新打开以前批准的工资单 |
get_payroll_paper_checks | GET | 获取工资单的纸质支票 |
get_payroll_cash_requirement_report | GET | 获取现金需求报告 |
get_payroll_paper_checks_report | GET | 获取纸质支票报告 |
simulate_start_processing | POST | 模拟启动处理(沙盒) |
simulate_complete_funding | POST | 模拟完成融资(沙盒) |
simulate_fail_funding | POST | 模拟失败的融资(沙盒) |
simulate_complete_disbursements | POST | 模拟完成支出(沙盒) |
工资单项目(8个工具)
| 工具 | 方法 | 说明 |
|---|---|---|
list_payroll_items | GET | 列出工资单项目 |
get_payroll_item | GET | 获取特定工资单项目的详细信息 |
create_payroll_item | POST | 创建新的工资单项目 |
update_payroll_item | PATCH | 更新现有工资单项目 |
bulk_update_payroll_items | PATCH | 批量更新工资单项目 |
delete_payroll_item | DELETE | 删除工资单项目 |
bulk_delete_payroll_items | DELETE | 批量删除工资单项目 |
get_payroll_item_paper_check | GET | 获取工资单项目的纸质支票 |
承包商付款(6种工具)
| 工具 | 方法 | 说明 |
|---|---|---|
list_contractor_payments | GET | 列出承包商付款 |
get_contractor_payment | GET | 获取特定付款的详细信息 |
create_contractor_payment | POST | 创建新的承包商付款 |
update_contractor_payment | PATCH | 更新承包商付款 |
delete_contractor_payment | DELETE | 删除承包商付款 |
get_contractor_payment_paper_check | GET | 获取纸质支票进行付款 |
外部工资单(8个工具)
| 工具 | 方法 | 说明 |
|---|---|---|
list_external_payrolls | GET | 列出外部工资单 |
get_external_payroll | GET | 获取特定外部工资单的详细信息 |
create_external_payroll | POST | 创建新的外部工资单 |
update_external_payroll | PATCH | 更新外部工资单 |
delete_external_payroll | DELETE | 删除外部工资单 |
approve_external_payroll | POST | 批准外部工资单 |
reopen_external_payroll | POST | 重新打开外部工资单 |
preview_external_payroll | GET | 预览外部工资单 |
补偿(32工具)
工资表、福利、税后扣除、公司福利、收入率、收入代码和净工资分割。
| 工具 | 方法 | 说明 |
|---|---|---|
| 工资表 | ||
list_pay_schedules | GET | 列出工资表 |
get_pay_schedule | GET | 获取具体的工资表 |
create_pay_schedule | POST | 创建新的工资表 |
update_pay_schedule | PATCH | 更新工资表 |
delete_pay_schedule | DELETE | 删除付款计划 |
get_pay_schedule_paydays | 获取 | 获取工资表的发薪日 |
| 好处 | ||
list_benefits | GET | 列出员工福利 |
get_benefit | GET | 获得特定福利 |
create_benefit | POST | 创建员工福利 |
update_benefit | PATCH | 更新福利 |
delete_benefit | DELETE | 删除福利 |
| 税后扣除 | ||
list_post_tax_deductions | GET | 列出税后扣除额 |
get_post_tax_deduction | GET | 获得特定的税后扣除 |
create_post_tax_deduction | POST | 创建税后扣除 |
update_post_tax_deduction | PATCH | 更新税后扣除 |
delete_post_tax_deduction | DELETE | 删除税后扣除 |
| 公司福利 | ||
list_company_benefits | GET | 列出公司级福利 |
get_company_benefit | GET | 获得特定的公司福利 |
create_company_benefit | POST | 创造公司利益 |
update_company_benefit | PATCH | 更新公司福利 |
delete_company_benefit | DELETE | 删除公司福利 |
| 收益率 | ||
list_earning_rates | GET | 列出收益率 |
get_earning_rate | GET | 获取特定的收益率 |
create_earning_rate | POST | 创建收益率 |
update_earning_rate | PATCH | 更新收益率 |
| 收益代码 | ||
list_earning_codes | GET | 列出收益代码 |
get_earning_code | GET | 获取特定的收益代码 |
create_earning_code | POST | 创建赚取代码 |
update_earning_code | PATCH | 更新奖励代码 |
| 净薪酬拆分 | ||
list_net_pay_splits | GET | 列出净薪酬分割 |
get_net_pay_split | GET | 获取特定的净薪酬分配 |
create_net_pay_split | POST | 创建净工资分割 |
银行账户(6个工具)
| 工具 | 方法 | 说明 |
|---|---|---|
list_bank_accounts | GET | 列出银行账户 |
get_bank_account | GET | 获取特定的银行账户 |
create_bank_account | POST | 创建新的银行账户 |
update_bank_account | PATCH | 更新银行账户 |
delete_bank_account | DELETE | 删除银行账户 |
reveal_bank_account_number | GET | 显示完整帐号 |
文档(19个工具)
| 工具 | 方法 | 说明 |
|---|---|---|
| 公司税务文件 | ||
list_company_tax_documents | GET | 列出公司税务文件 |
get_company_tax_document | GET | 获取特定的公司税务文件 |
download_company_tax_document | GET | 下载公司税务文件 |
| 公司授权文件 | ||
list_company_authorization_documents | GET | 列出授权文件 |
get_company_authorization_document | GET | 获取授权文件 |
download_company_authorization_document | GET | 下载授权文件 |
| 员工税务文件 | ||
list_employee_tax_documents | GET | 列出员工税务文件 |
get_employee_tax_document | GET | 获取员工税务文件 |
download_employee_tax_document | GET | 下载员工税务文件 |
| 承包商税务文件 | ||
list_contractor_tax_documents | GET | 列出承包商税务文件 |
get_contractor_tax_document | GET | 获取承包商税务文件 |
download_contractor_tax_document | GET | 下载承包商税务文件 |
| 设置文档 | ||
list_setup_documents | GET | 列出设置文档 |
get_setup_document | GET | 获取设置文档 |
download_setup_document | GET | 下载安装文档 |
| 公司提供的文件 | ||
list_company_provided_documents | GET | 列出公司提供的文件 |
get_company_provided_document | GET | 获取公司提供的文档 |
create_company_provided_document | POST | 创建公司提供的文档 |
upload_company_provided_document_file | POST | 上传文档的文件 |
表格(4个工具)
| 工具 | 方法 | 说明 |
|---|---|---|
list_forms | GET | 列出所有公司的表单 |
get_form | GET | 获取特定表单 |
render_form | GET | 渲染表单以供显示 |
validate_form | POST | 提交前验证表单数据 |
付款(6种工具)
| 工具 | 方法 | 说明 |
|---|---|---|
list_payments | GET | 列出付款 |
get_payment | GET | 获取特定付款 |
list_payment_attempts | GET | 列出付款尝试 |
retry_payment | POST | 重试失败的付款 |
refund_payment | POST | 退款 |
cancel_payment | POST | 取消付款 |
税(31工具)
税务参数、选择、申报、免税状态、免税、报表和套餐。
| 工具 | 方法 | 说明 |
|---|---|---|
| 公司税务参数 | ||
get_company_tax_params | GET | 获取公司的税务参数 |
update_company_tax_params | PATCH | 更新公司税务参数 |
list_company_tax_param_settings | GET | 列出税务参数设置 |
get_company_tax_param_setting | GET | 获取特定的税务参数设置 |
list_company_jurisdictions | GET | 列出公司的税务管辖区 |
| 员工税务参数 | ||
list_employee_tax_params | GET | 列出员工税务参数 |
get_employee_tax_params | GET | 获取员工的税务参数 |
update_employee_tax_params | PATCH | 更新员工税务参数 |
list_employee_tax_param_settings | GET | 列出员工税务参数设置 |
get_employee_tax_param_setting | GET | 获取特定设置 |
list_employee_jurisdictions | GET | 列出员工的税务管辖区 |
bulk_get_employee_tax_param_settings | POST | 批量获取税务参数设置 |
bulk_update_employee_tax_param_settings | POST | 批量更新税务参数设置 |
| 公司税务选举 | ||
list_company_tax_elections | GET | 列出公司的税务选择 |
create_company_tax_elections | POST | 创建公司税务选举 |
update_company_tax_elections | PATCH | 更新公司税务选举 |
| 员工税务选举 | ||
list_employee_tax_elections | GET | 列出员工的税务选择 |
update_employee_tax_elections | PATCH | 更新员工税务选举 |
| 税务申报 | ||
list_tax_filings | GET | 列出税务申报 |
get_tax_filing | GET | 获取特定的税务申报 |
request_tax_filing_refile | POST | 请求重新提交 |
| 税务申报事件 | ||
get_tax_filing_event | GET | 获取特定的税务申报事件 |
| 豁免状态 | ||
get_exempt_status | GET | 为员工获取豁免状态 |
update_exempt_status | PATCH | 更新豁免状态 |
| 免税 | ||
list_exemptible_taxes | GET | 列出免税额 |
update_exemptible_tax | PATCH | 更新免税 |
bulk_update_exemptible_taxes | PATCH | 批量更新免税 |
| 员工税务报表 | ||
list_employee_tax_statements | GET | 列出员工税务报表 |
get_employee_tax_statement | GET | 获取特定的税务报表 |
| 税务套餐 | ||
request_tax_package | POST | 申请税务套餐 |
get_tax_package | GET | 获取特定的税务套餐 |
Webhooks(7个工具)
| 工具 | 方法 | 说明 |
|---|---|---|
list_webhook_configs | GET | 列出webhook配置 |
get_webhook_config | GET | 获取特定的webhook配置 |
create_webhook_config | POST | 创建webhook配置 |
update_webhook_config | PATCH | 更新webhook配置 |
delete_webhook_config | DELETE | 删除webhook配置 |
ping_webhook_config | POST | 发送测试ping |
retry_webhook_events | POST | 重试失败的webhook事件 |
平台(29个工具)
通知、通信、使用、集成、会计、公司组、地址、设置和要求。
| 工具 | 方法 | 说明 |
|---|---|---|
| 通知 | ||
list_notifications | GET | 列出通知 |
get_notification | GET | 获取特定通知 |
| 通信 | ||
list_communications | GET | 列出通信 |
get_communication | GET | 获取特定通信 |
create_communication | POST | 创建通信 |
| 用法 | ||
list_usage_summaries | GET | 列出使用情况摘要 |
list_usage_records | GET | 列出使用记录 |
| 集成 | ||
list_integration_partners | GET | 列出集成合作伙伴 |
get_integration_partner | GET | 获取特定的集成合作伙伴 |
authorize_integration_partner | POST | 授权集成合作伙伴 |
list_integration_permissions | GET | 列出集成权限 |
get_integration_permission | GET | 获取特定权限 |
list_integration_accesses | GET | 列出集成访问 |
| 会计 | ||
list_accounting_accounts | GET | 列出公司的会计账户 |
refresh_accounting_accounts | POST | 刷新会计账户 |
get_accounting_mappings | GET | 获取会计映射 |
update_accounting_mappings | PATCH | 更新会计映射 |
toggle_accounting_mappings | POST | 切换记帐映射 |
sync_accounting | POST | 触发会计同步 |
list_accounting_sync_attempts | GET | 列出记帐同步尝试次数 |
| 公司集团 | ||
list_company_groups | GET | 列出公司组 |
create_company_group | POST | 创建公司组 |
update_company_group | PATCH | 更新公司组 |
| 地址 | ||
validate_address | POST | 验证地址 |
| 设置 | ||
list_setups | GET | 列表设置 |
get_setup | GET | 获取特定设置 |
| 需求 | ||
list_requirements | GET | 列出要求 |
get_requirement | GET | 获取特定要求 |
| 报告 | ||
get_applied_for_ids_report | GET | 申请ID报告 |
嵌入式组件(35个工具)
通过以下方式生成可嵌入的UI组件URL POST /{entity_type}/{entity_id}/components/{component_type}.所有工具都接受 entity_id 可选 data 配置。
公司组成部分(25): create_company_previous_provider_access_component, create_company_accounting_integration_component, create_company_authorization_documents_component, create_company_business_details_component, create_company_checklist_component, create_company_company_reports_component, create_company_connect_bank_account_component, create_company_details_component, create_company_early_enrollment_component, create_company_employee_setup_component, create_company_filing_authorization_component, create_company_filing_preview_component, create_company_full_service_setup_submission_component, create_company_integrations_component, create_company_integrations_authorize_component, create_company_pay_history_component, create_company_payment_setup_component, create_company_progress_tracker_component, create_company_run_payroll_component, create_company_signatory_agreements_component, create_company_tax_documents_component, create_company_tax_setup_component, create_company_team_setup_component, create_company_terms_of_service_component, create_company_verification_documents_component
员工构成(9): create_employee_benefits_component, create_employee_payment_setup_component, create_employee_paystubs_component, create_employee_post_tax_deductions_component, create_employee_profile_component, create_employee_ssn_setup_component, create_employee_tax_documents_component, create_employee_tax_setup_component, create_employee_withholdings_setup_component
承包商组成部分(1): create_contractor_tax_documents_component
发展
git clone https://github.com/check-technologies/mcp-server-check.git
cd mcp-server-check
uv sync --group dev
uv run pytest # 311 tests