Skip to main content

McpApi

valkyrai-api​

All URIs are relative to http://localhost:8080/v1

MethodHTTP requestDescription
getMcpServiceGET McpApiGet MCP service details

getMcpService

McpServiceRegistry
getMcpService(slug)

Get MCP service details

Retrieves detailed information about a published MCP service

Example​

Import classes:
import com.valkyrlabs.ApiException;
import com.valkyrlabs.api.McpApi;


McpApi apiInstance = new McpApi();
String slug = "slug_example"; // String | Service slug identifier

try {
    McpServiceRegistry result = apiInstance.getMcpService(slug);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling McpApi#getMcpService");
    e.printStackTrace();
}

Parameters​

NameTypeDescriptionNotes
slugStringService slug identifier

Return type​

McpServiceRegistry

Authorization​

No authorization required

HTTP request headers​

  • Content-Type: Not defined
  • Accept: application/json

getMcpServiceManifest

String
getMcpServiceManifest(slug)

Download MCP service manifest

Returns the manifest.yaml file for a published MCP service (machine-readable format)

Example​

Import classes:
import com.valkyrlabs.ApiException;
import com.valkyrlabs.api.McpApi;


McpApi apiInstance = new McpApi();
String slug = "slug_example"; // String | Service slug identifier

try {
    String result = apiInstance.getMcpServiceManifest(slug);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling McpApi#getMcpServiceManifest");
    e.printStackTrace();
}

Parameters​

NameTypeDescriptionNotes
slugStringService slug identifier

Return type​

String

Authorization​

No authorization required

HTTP request headers​

  • Content-Type: Not defined
  • Accept: application/yaml

invokeMcpTool

Object
invokeMcpTool(sluginvokeMcpToolRequest)

Invoke an MCP tool within a service

Calls a specific tool within a published MCP service

Example​

Import classes:
import com.valkyrlabs.ApiException;
import com.valkyrlabs.api.McpApi;


McpApi apiInstance = new McpApi();
String slug = "slug_example"; // String | Service slug identifier
InvokeMcpToolRequest invokeMcpToolRequest = new InvokeMcpToolRequest(); // InvokeMcpToolRequest | 

try {
    Object result = apiInstance.invokeMcpTool(sluginvokeMcpToolRequest);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling McpApi#invokeMcpTool");
    e.printStackTrace();
}

Parameters​

NameTypeDescriptionNotes
slugStringService slug identifier
invokeMcpToolRequestInvokeMcpToolRequest

Return type​

Object

Authorization​

No authorization required

HTTP request headers​

  • Content-Type: application/json
  • Accept: application/json

listMcpServices

McpServiceRegistry
listMcpServices(publishedcategory)

List all published MCP services

Returns registry of all published MCP services available in marketplace

Example​

Import classes:
import com.valkyrlabs.ApiException;
import com.valkyrlabs.api.McpApi;


McpApi apiInstance = new McpApi();
Boolean published = true; // Boolean | Filter by publication status
String category = "category_example"; // String | Filter by service category

try {
    McpServiceRegistry result = apiInstance.listMcpServices(publishedcategory);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling McpApi#listMcpServices");
    e.printStackTrace();
}

Parameters​

NameTypeDescriptionNotes
publishedBooleanFilter by publication status[optional]
categoryStringFilter by service category[optional]

Return type​

McpServiceRegistry

Authorization​

No authorization required

HTTP request headers​

  • Content-Type: Not defined
  • Accept: application/json

publishRestEndpointAsMcp

McpServiceResponse
publishRestEndpointAsMcp(publishRestEndpointRequest)

Publish a Spring REST endpoint as an MCP tool

Scans a Spring controller and publishes its endpoints as MCP tools in the marketplace

Example​

Import classes:
import com.valkyrlabs.ApiException;
import com.valkyrlabs.api.McpApi;


McpApi apiInstance = new McpApi();
PublishRestEndpointRequest publishRestEndpointRequest = new PublishRestEndpointRequest(); // PublishRestEndpointRequest | 

try {
    McpServiceResponse result = apiInstance.publishRestEndpointAsMcp(publishRestEndpointRequest);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling McpApi#publishRestEndpointAsMcp");
    e.printStackTrace();
}

Parameters​

NameTypeDescriptionNotes
publishRestEndpointRequestPublishRestEndpointRequest

Return type​

McpServiceResponse

Authorization​

No authorization required

HTTP request headers​

  • Content-Type: application/json
  • Accept: application/json

publishWorkflowAsMcp

McpServiceResponse
publishWorkflowAsMcp(publishWorkflowRequest)

Publish a ValkyrAI workflow as an MCP tool

Creates an MCP tool that invokes a workflow when called

Example​

Import classes:
import com.valkyrlabs.ApiException;
import com.valkyrlabs.api.McpApi;


McpApi apiInstance = new McpApi();
PublishWorkflowRequest publishWorkflowRequest = new PublishWorkflowRequest(); // PublishWorkflowRequest | 

try {
    McpServiceResponse result = apiInstance.publishWorkflowAsMcp(publishWorkflowRequest);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling McpApi#publishWorkflowAsMcp");
    e.printStackTrace();
}

Parameters​

NameTypeDescriptionNotes
publishWorkflowRequestPublishWorkflowRequest

Return type​

McpServiceResponse

Authorization​

No authorization required

HTTP request headers​

  • Content-Type: application/json
  • Accept: application/json

unpublishMcpService

Void
unpublishMcpService(slug)

Unpublish MCP service

Removes a service from the marketplace and stops it from being discoverable

Example​

Import classes:
import com.valkyrlabs.ApiException;
import com.valkyrlabs.api.McpApi;


McpApi apiInstance = new McpApi();
String slug = "slug_example"; // String | Service slug identifier

try {
    Void result = apiInstance.unpublishMcpService(slug);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling McpApi#unpublishMcpService");
    e.printStackTrace();
}

Parameters​

NameTypeDescriptionNotes
slugStringService slug identifier

Return type​

Void

Authorization​

No authorization required

HTTP request headers​

  • Content-Type: Not defined
  • Accept: Not defined

updateMcpService

McpServiceRegistry
updateMcpService(slugmcpServiceRegistry)

Update MCP service

Updates metadata and configuration for a published MCP service

Example​

Import classes:
import com.valkyrlabs.ApiException;
import com.valkyrlabs.api.McpApi;


McpApi apiInstance = new McpApi();
String slug = "slug_example"; // String | Service slug identifier
McpServiceRegistry mcpServiceRegistry = new McpServiceRegistry(); // McpServiceRegistry | 

try {
    McpServiceRegistry result = apiInstance.updateMcpService(slugmcpServiceRegistry);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling McpApi#updateMcpService");
    e.printStackTrace();
}

Parameters​

NameTypeDescriptionNotes
slugStringService slug identifier
mcpServiceRegistryMcpServiceRegistry

Return type​

McpServiceRegistry

Authorization​

No authorization required

HTTP request headers​

  • Content-Type: application/json
  • Accept: application/json

Generated Version Details​

~value
GENERATOR VERSIONcom.valkyrlabs:ValkyrAI API 1.0.1-SNAPSHOT
API ARTIFACTcom.valkyrlabs.valkyrai-api.jar
GENERATOR VERSIONorg.openapitools.openapi-generator:7.5.0
GENERATOR CLASSorg.openapitools.codegen.languages.SpringCodegen
GENERATED DATE2025-12-03T11:13:18.492704-08:00[America/Los_Angeles]