openapi-mcp-proxy

### OpenAPI Schema Exploration Report: Salesforce API (v58.0)

**Explored Schema:** `https://developer.salesforce.com/docs/api/explore`
**Focus Area:** Lead and Opportunity Management
**Operation Method:** GET, POST, PATCH

---

#### 1. Relevant Endpoints Identified:

| Endpoint | Method | Description |
|----------|--------|-------------|
| `/services/data/v58.0/sobjects/Lead` | GET | Retrieve a list of leads with optional filtering. |
| `/services/data/v58.0/sobjects/Lead/{id}` | GET | Retrieve a specific lead by ID. |
| `/services/data/v58.0/sobjects/Lead` | POST | Create a new lead record. |
| `/services/data/v58.0/sobjects/Lead/{id}` | PATCH | Update an existing lead record. |

---

#### 2. Key Parameters and Data Types:

**Query Parameters for `GET /sobjects/Lead`:**
- `q` (string): SOQL query string (e.g., `q=LastName LIKE 'Smith'`).
- `fields` (string): Comma-separated list of fields to return (e.g., `fields=Id,Name,Email,Company`).
- `limit` (integer): Maximum number of records to return (default: 200, max: 2000).

**Request Body for `POST /sobjects/Lead`:**
```json
{
  "FirstName": "Jane",
  "LastName": "Doe",
  "Company": "TechCorp",
  "Email": "[email protected]",
  "Phone": "+1 (555) 123-4567",
  "Status__c": "New",
  "LeadSource": "Web"
}
```

**Response Fields for `GET /sobjects/Lead/{id}`:**
- `Id` (string): Unique identifier for the lead (e.g., `00Q5g000006J5hOEAS`).
- `Name` (string): Full name of the lead (e.g., `Jane Doe`).
- `Company` (string): Company name (e.g., `TechCorp`).
- `Email` (string): Email address (e.g., `[email protected]`).
- `Status__c` (string): Custom field for lead status (e.g., `New`, `Contacted`, `Qualified`).

---

#### 3. Example Request/Response Pairs:

**Example 1: Retrieve Leads with SOQL Query**
**Request:**
```
GET /services/data/v58.0/query?q=SELECT+Id,Name,Email,Company+FROM+Lead+WHERE+Status__c='New'+LIMIT+10
```
**Response:**
```json
{
  "totalSize": 3,
  "done": true,
  "records": [
    {
      "Id": "00Q5g000006J5hOEAS",
      "Name": "Jane Doe",
      "Email": "[email protected]",
      "Company": "TechCorp"
    },
    {
      "Id": "00Q5g000006J5hOEAQ",
      "Name": "John Smith",
      "Email": "[email protected]",
      "Company": "Innovate Inc."
    },
    {
      "Id": "00Q5g000006J5hOFAA",
      "Name": "Sarah Johnson",
      "Email": "[email protected]",
      "Company": "Global Solutions"
    }
  ]
}
```

**Example 2: Create a New Lead**
**Request:**
```
POST /services/data/v58.0/sobjects/Lead
Headers: {"Authorization": "Bearer [ACCESS_TOKEN]"}
Body:
{
  "FirstName": "Michael",
  "LastName": "Brown",
  "Company": "DataSystems",
  "Email": "[email protected]",
  "Phone": "+1 (555) 987-6543",
  "Status__c": "New",
  "LeadSource": "Web"
}
```
**Response:**
```json
{
  "id": "00Q5g000006J5hOGAS",
  "success": true,
  "errors": []
}
```

---

#### 4. Constraints and Limitations:

- **Rate Limits:** Salesforce enforces a limit of **100 requests per 20 seconds** for standard API calls. Exceeding this limit results in a `429 Too Many Requests` error.
- **Field Length:** The `Company` field has a maximum length of **255 characters**. Attempting to create a lead with a longer company name will result in a validation error.
- **Required Fields:** The `LastName` field is required for lead creation. Omitting it will trigger an error.
- **Custom Fields:** Custom fields (e.g., `Status__c`) must be explicitly enabled in the Salesforce schema. If not enabled, the API will return a `400 Bad Request` error.

---

#### Summary:
This exploration of the Salesforce API schema reveals a robust set of endpoints for lead and opportunity management. The schema supports CRUD operations with clear parameter requirements and response structures. Key takeaways include the need to handle rate limits, validate custom field availability, and ensure required fields are populated during lead creation. This summary can be used to guide API integration efforts or troubleshoot existing workflows.