|
| 1 | +# goadserver.AIAssistantApi |
| 2 | + |
| 3 | +All URIs are relative to *https://up.go-adserver.com* |
| 4 | + |
| 5 | +Method | HTTP request | Description |
| 6 | +------------- | ------------- | ------------- |
| 7 | +[**api_v1_mcp_post**](AIAssistantApi.md#api_v1_mcp_post) | **POST** /api/v1/mcp | MCP endpoint — connect an AI assistant to this account. |
| 8 | + |
| 9 | + |
| 10 | +# **api_v1_mcp_post** |
| 11 | +> ApiV1McpPost200Response api_v1_mcp_post(api_v1_mcp_post_request) |
| 12 | +
|
| 13 | +MCP endpoint — connect an AI assistant to this account. |
| 14 | + |
| 15 | +Model Context Protocol server (JSON-RPC 2.0 over HTTP). Point an MCP |
| 16 | +client at this URL with `Authorization: Bearer gas_live_…` and the |
| 17 | +assistant can use the account through a curated set of tools. |
| 18 | + |
| 19 | +The key must be marked **"Allow this key to connect an AI assistant"** |
| 20 | +in MyAccount → API access; keys minted before that option existed are |
| 21 | +not agent-capable. The tools an assistant sees are filtered by the |
| 22 | +key's scopes, so a read-only key is never shown a write tool. |
| 23 | + |
| 24 | +Methods: `initialize`, `ping`, `tools/list`, `tools/call`. One |
| 25 | +JSON-RPC request per POST — batching is not accepted. Tool calls are |
| 26 | +rate limited separately from the REST API (default 240/min per key); |
| 27 | +`initialize`, `ping` and `tools/list` are free. |
| 28 | + |
| 29 | + |
| 30 | +### Example |
| 31 | + |
| 32 | +* Bearer (gas_live_<32 chars>) Authentication (apiKey): |
| 33 | + |
| 34 | +```python |
| 35 | +import goadserver |
| 36 | +from goadserver.models.api_v1_mcp_post200_response import ApiV1McpPost200Response |
| 37 | +from goadserver.models.api_v1_mcp_post_request import ApiV1McpPostRequest |
| 38 | +from goadserver.rest import ApiException |
| 39 | +from pprint import pprint |
| 40 | + |
| 41 | +# Defining the host is optional and defaults to https://up.go-adserver.com |
| 42 | +# See configuration.py for a list of all supported configuration parameters. |
| 43 | +configuration = goadserver.Configuration( |
| 44 | + host = "https://up.go-adserver.com" |
| 45 | +) |
| 46 | + |
| 47 | +# The client must configure the authentication and authorization parameters |
| 48 | +# in accordance with the API server security policy. |
| 49 | +# Examples for each auth method are provided below, use the example that |
| 50 | +# satisfies your auth use case. |
| 51 | + |
| 52 | +# Configure Bearer authorization (gas_live_<32 chars>): apiKey |
| 53 | +configuration = goadserver.Configuration( |
| 54 | + access_token = os.environ["BEARER_TOKEN"] |
| 55 | +) |
| 56 | + |
| 57 | +# Enter a context with an instance of the API client |
| 58 | +with goadserver.ApiClient(configuration) as api_client: |
| 59 | + # Create an instance of the API class |
| 60 | + api_instance = goadserver.AIAssistantApi(api_client) |
| 61 | + api_v1_mcp_post_request = goadserver.ApiV1McpPostRequest() # ApiV1McpPostRequest | |
| 62 | + |
| 63 | + try: |
| 64 | + # MCP endpoint — connect an AI assistant to this account. |
| 65 | + api_response = api_instance.api_v1_mcp_post(api_v1_mcp_post_request) |
| 66 | + print("The response of AIAssistantApi->api_v1_mcp_post:\n") |
| 67 | + pprint(api_response) |
| 68 | + except Exception as e: |
| 69 | + print("Exception when calling AIAssistantApi->api_v1_mcp_post: %s\n" % e) |
| 70 | +``` |
| 71 | + |
| 72 | + |
| 73 | + |
| 74 | +### Parameters |
| 75 | + |
| 76 | + |
| 77 | +Name | Type | Description | Notes |
| 78 | +------------- | ------------- | ------------- | ------------- |
| 79 | + **api_v1_mcp_post_request** | [**ApiV1McpPostRequest**](ApiV1McpPostRequest.md)| | |
| 80 | + |
| 81 | +### Return type |
| 82 | + |
| 83 | +[**ApiV1McpPost200Response**](ApiV1McpPost200Response.md) |
| 84 | + |
| 85 | +### Authorization |
| 86 | + |
| 87 | +[apiKey](../README.md#apiKey) |
| 88 | + |
| 89 | +### HTTP request headers |
| 90 | + |
| 91 | + - **Content-Type**: application/json |
| 92 | + - **Accept**: application/json |
| 93 | + |
| 94 | +### HTTP response details |
| 95 | + |
| 96 | +| Status code | Description | Response headers | |
| 97 | +|-------------|-------------|------------------| |
| 98 | +**200** | JSON-RPC response. | - | |
| 99 | +**202** | Notification accepted (no response body). | - | |
| 100 | +**404** | MCP is not available on this instance or for this network. | - | |
| 101 | + |
| 102 | +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) |
| 103 | + |
0 commit comments