ForceWeaver MCP API Documentation

Authorization: Bearer fk_your_api_key_here

{
  "org_id": "production",
  "check_types": [
    "basic_org_info",
    "sharing_model",
    "data_integrity"
  ],
  "api_version": "v64.0"
}

{
  "success": true,
  "org_id": "production",
  "org_name": "Acme Corp Production",
  "check_types": [
    "basic_org_info",
    "sharing_model",
    "data_integrity"
  ],
  "results": {
    "basic_org_info": {
      "status": "success",
      "score": 90,
      "details": [
        "Organization: Acme Corp Production",
        "Type: Production",
        "Users: 150",
        "Currency: USD properly configured"
      ],
      "recommendations": []
    },
    "sharing_model": {
      "status": "success", 
      "score": 88,
      "details": [
        "Account sharing: Private",
        "Opportunity sharing: Private with role hierarchy",
        "2 sharing rules configured"
      ],
      "recommendations": [
        "Review guest user sharing settings"
      ]
    },
    "data_integrity": {
      "status": "warning",
      "score": 78,
      "details": [
        "Found 15 duplicate accounts",
        "3 orphaned contacts detected",
        "Custom field validation: Good"
      ],
      "recommendations": [
        "Run duplicate management process"
      ]
    },
    "overall_score": 85
  },
  "summary": {
    "overall_score": 85,
    "checks_performed": 3,
    "execution_time_ms": 1250,
    "cost_cents": 3
  }
}

{
  "error": "Invalid check types",
  "message": "Invalid check types: ['invalid_check']",
  "valid_check_types": [
    "basic_org_info",
    "sharing_model",
    "bundle_analysis",
    "data_integrity",
    "performance_metrics",
    "security_audit"
  ]
}

{
  "success": true,
  "check_types": [
    {
      "name": "basic_org_info",
      "description": "Organization details and setup validation",
      "cost_cents": 1,
      "category": "basic"
    },
    {
      "name": "sharing_model",
      "description": "Sharing rules and permissions analysis",
      "cost_cents": 1,
      "category": "basic"
    },
    {
      "name": "bundle_analysis",
      "description": "Revenue Cloud bundle configuration review",
      "cost_cents": 1,
      "category": "basic"
    },
    {
      "name": "data_integrity",
      "description": "Data quality and consistency validation",
      "cost_cents": 1,
      "category": "basic"
    },
    {
      "name": "performance_metrics",
      "description": "System performance analysis and optimization",
      "cost_cents": 5,
      "category": "premium"
    },
    {
      "name": "security_audit",
      "description": "Comprehensive security configuration review",
      "cost_cents": 5,
      "category": "premium"
    }
  ],
  "total_available": 6
}

import requests

api_key = "fk_your_api_key_here"
base_url = "https://mcp.forceweaver.com/api/v1.0"
headers = {"Authorization": f"Bearer {api_key}"}

# Step 1: List available organizations
orgs_response = requests.post(
    f"{base_url}/orgs/list",
    headers=headers,
    json={"username": "user@example.com"}
)

# Step 2: Get available check types (optional)
check_types_response = requests.get(f"{base_url}/health/check-types")
available_checks = check_types_response.json()["check_types"]

# Step 3: Run health check on first organization
orgs = orgs_response.json()["organizations"]
if orgs:
    org_id = orgs[0]["org_id"]
    
    health_response = requests.post(
        f"{base_url}/health/check",
        headers=headers,
        json={
            "org_id": org_id,
            "check_types": ["basic_org_info", "sharing_model", "data_integrity"],
            "api_version": "v64.0"
        }
    )
    
    results = health_response.json()
    print(f"🏥 Health Check Results for {results['org_name']}")
    print(f"📊 Overall Score: {results['summary']['overall_score']}/100")
    print(f"💰 Cost: ${results['summary']['cost_cents']/100:.2f}")
    print(f"⏱️ Execution Time: {results['summary']['execution_time_ms']}ms")
    
    # Display individual check results
    for check_name, check_result in results["results"].items():
        if check_name != "overall_score":
            status_emoji = "✅" if check_result["status"] == "success" else "⚠️"
            print(f"\n{status_emoji} {check_name.replace('_', ' ').title()}")
            print(f"   Score: {check_result['score']}/100")
            
            for detail in check_result["details"][:3]:  # Show first 3 details
                print(f"   • {detail}")
                
            if check_result["recommendations"]:
                print(f"   🔧 Recommendations:")
                for rec in check_result["recommendations"]:
                    print(f"      - {rec}")

print("\n🎯 Health check complete!")

{
  "api_key": "fk_1234567890abcdef1234567890abcdef",
  "org_id": "production"
}

{
  "valid": true,
  "user_id": "user-uuid-here",
  "api_key_id": "key-uuid-here", 
  "org_id": "production",
  "salesforce_credentials": {
    "instance_url": "https://company.my.salesforce.com",
    "client_id": "3MVG9...",
    "client_secret": "xxx",
    "access_token": "00D...",
    "refresh_token": "5Aep..."
  }
}

{
  "error": "Invalid API key",
  "message": "API key not found or inactive"
}

{
  "user_id": "user-uuid-here",
  "api_key_id": "key-uuid-here",
  "salesforce_org_id": "org-uuid-here",
  "tool_name": "revenue_cloud_health_check",
  "execution_time_ms": 1250,
  "success": true,
  "cost_cents": 3,
  "request_id": "req_abc123"
}

{
  "logged": true,
  "usage_id": "usage-uuid-here"
}

{
  "status": "healthy",
  "service": "ForceWeaver Internal API",
  "version": "1.0.0",
  "timestamp": 1703123456.789
}

{
  "status": "unhealthy", 
  "error": "Database connection failed"
}