portugalfuturista/z-ai-sdk-java
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

feat: chatCompletion supports mcp tool (#37)

Browse source
This commit is contained in:
Lighthousexx 2025-08-14 20:05:45 +08:00 committed by GitHub
parent f4e27659ff
commit 73f392e271
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
8 changed files with 239 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
core/src/main/java/ai/z/openapi/service/model/ChatTool.java
View file

@ -23,4 +23,7 @@ public class ChatTool {
@JsonProperty("web_search")
private WebSearch webSearch;
@JsonProperty("mcp")
private MCPTool mcp;
}

4
core/src/main/java/ai/z/openapi/service/model/ChatToolType.java
View file

@ -6,7 +6,9 @@ public enum ChatToolType {
RETRIEVAL("retrieval"),
FUNCTION("function");
FUNCTION("function"),
MCP("mcp"),;
private final String value;

43
core/src/main/java/ai/z/openapi/service/model/MCPTool.java Normal file
View file

@ -0,0 +1,43 @@
package ai.z.openapi.service.model;
import com.fasterxml.jackson.databind.JsonNode;
import com.fasterxml.jackson.databind.node.JsonNodeFactory;
import com.fasterxml.jackson.databind.node.ObjectNode;
import lombok.*;
import java.util.Map;
import java.util.Set;
@Data
@Builder
@NoArgsConstructor
@AllArgsConstructor
public class MCPTool {
/**
* Identifier for the MCP server, used to distinguish different MCP servers, required
*/
private String server_label;
/**
* URL of the MCP server, optional Default (if this field is empty): use server_label
* as mcpCode to connect to Zhipu AI's MCP servers
*/
private String server_url;
/**
* Transport method for MCP calls: sse/streamable-http, defaults to streamable-http
*/
private String transport_type;
/**
* List of allowed tools to call, defaults to empty (allowing all tools)
*/
private Set<String> allowed_tools;
/**
* Headers for connecting to MCP server, used for authentication
*/
private Map<String, String> headers;
}

39
core/src/main/java/ai/z/openapi/service/model/MCPToolCall.java Normal file
View file

@ -0,0 +1,39 @@
package ai.z.openapi.service.model;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
import java.io.Serializable;
import java.util.List;
@Data
@NoArgsConstructor
@AllArgsConstructor
public class MCPToolCall implements Serializable {
private static final long serialVersionUID = 2080214859980927710L;
// Unique identifier for MCP tool call
private String id;
private String type;
private String server_label;
private String error;
// type = mcp_list_tools
private List<MCPToolDefinition> tools;
// type = mcp_call
// Tool call parameters, parameters as JSON string
private String arguments;
// Tool name
private String name;
// Tool result output
private Object output;
}

50
core/src/main/java/ai/z/openapi/service/model/MCPToolDefinition.java Normal file
View file

@ -0,0 +1,50 @@
package ai.z.openapi.service.model;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
import java.io.Serializable;
import java.util.List;
import java.util.Map;
@Data
@NoArgsConstructor
@AllArgsConstructor
public class MCPToolDefinition implements Serializable {
private static final long serialVersionUID = -3960033025319205212L;
// Tool name
private String name;
// Tool description
private String description;
private Object annotations;
// Tool input parameter specification
private InputSchema input_schema;
@Data
@NoArgsConstructor
@AllArgsConstructor
public static class InputSchema implements Serializable {
private static final long serialVersionUID = 4723599134723995986L;
// Fixed value "object"
private String type;
// Parameter properties definition
private Map<String, Object> properties;
// List of required properties
private List<String> required;
// Whether additional properties are allowed
private Boolean additionalProperties;
}
}

16
core/src/main/java/ai/z/openapi/service/model/McpToolTransportType.java Normal file
View file

@ -0,0 +1,16 @@
package ai.z.openapi.service.model;
import lombok.AllArgsConstructor;
import lombok.Getter;
@AllArgsConstructor
@Getter
public enum McpToolTransportType {
SSE("sse", "SSE"), STREAMABLE_HTTP("streamable-http", "streamable http");
private final String code;
private final String value;
}

5
core/src/main/java/ai/z/openapi/service/model/ToolCalls.java
View file

@ -27,9 +27,12 @@ public class ToolCalls {
private String id;
/**
* Type of tool called by the model, currently only supports 'function'.
* Type of tool called by the model, currently only supports 'function', 'mcp'.
*/
@JsonProperty("type")
private String type;
@JsonProperty("mcp")
private MCPToolCall mcp;
}

81
core/src/test/java/ai/z/openapi/service/chat/ChatServiceTest.java
View file

@ -3,6 +3,7 @@ package ai.z.openapi.service.chat;
import ai.z.openapi.ZaiClient;
import ai.z.openapi.core.Constants;
import ai.z.openapi.core.config.ZaiConfig;
import ai.z.openapi.service.model.*;
import ai.z.openapi.service.model.AsyncResultRetrieveParams;
import ai.z.openapi.service.model.ChatCompletionCreateParams;
import ai.z.openapi.service.model.ChatCompletionResponse;
@ -161,6 +162,86 @@ public class ChatServiceTest {
logger.info("Stream chat completion test completed");
}
@Test
@DisplayName("Test Synchronous Chat Completion - MCP Tool")
@EnabledIfEnvironmentVariable(named = "ZAI_API_KEY", matches = "^[^.]+\\.[^.]+$")
void testSyncChatCompletion_MCP_ServerUrl() throws JsonProcessingException {
// Prepare test data
List<ChatMessage> messages = new ArrayList<>();
ChatMessage userMessage = new ChatMessage(ChatMessageRole.USER.value(), "Hello, please introduce GPT?");
messages.add(userMessage);
String requestId = String.format(REQUEST_ID_TEMPLATE, System.currentTimeMillis());
ChatCompletionCreateParams request = ChatCompletionCreateParams.builder()
.model(Constants.ModelChatGLM4)
.stream(Boolean.FALSE)
.messages(messages)
.requestId(requestId)
.tools(Arrays.asList(ChatTool.builder()
.type(ChatToolType.MCP.value())
.mcp(MCPTool.builder()
.server_url("https://open.bigmodel.cn/api/mcp/sogou/sse")
.server_label("sougou")
.transport_type("sse")
.headers(Collections.singletonMap("Authorization", "Bearer " + System.getProperty("ZAI_API_KEY")))
.build())
.build()))
.build();
// Execute test
ChatCompletionResponse response = chatService.createChatCompletion(request);
// Verify results
assertNotNull(response, "Response should not be null");
assertTrue(response.isSuccess(), "Response should be successful");
assertNotNull(response.getData(), "Response data should not be null");
assertEquals(requestId, response.getData().getRequestId(), "Request ID should match");
assertNotNull(response.getData().getChoices(), "Response data should not be null");
assertFalse(response.getData().getChoices().isEmpty(), "Response data should not be empty");
assertNull(response.getError(), "Response error should be null");
logger.info("Synchronous chat completion response: {}", mapper.writeValueAsString(response));
}
@Test
@DisplayName("Test Synchronous Chat Completion - MCP Tool")
@EnabledIfEnvironmentVariable(named = "ZAI_API_KEY", matches = "^[^.]+\\.[^.]+$")
void testSyncChatCompletion_MCP_ServerLabel() throws JsonProcessingException {
// Prepare test data
List<ChatMessage> messages = new ArrayList<>();
ChatMessage userMessage = new ChatMessage(ChatMessageRole.USER.value(), "Hello, please introduce GPT?");
messages.add(userMessage);
String requestId = String.format(REQUEST_ID_TEMPLATE, System.currentTimeMillis());
ChatCompletionCreateParams request = ChatCompletionCreateParams.builder()
.model(Constants.ModelChatGLM4)
.stream(Boolean.FALSE)
.messages(messages)
.requestId(requestId)
.tools(Arrays.asList(ChatTool.builder()
.type(ChatToolType.MCP.value())
.mcp(MCPTool.builder()
.server_label("sougou_search")
.headers(Collections.singletonMap("Authorization", "Bearer " + System.getProperty("ZAI_API_KEY")))
.build())
.build()))
.build();
// Execute test
ChatCompletionResponse response = chatService.createChatCompletion(request);
// Verify results
assertNotNull(response, "Response should not be null");
assertTrue(response.isSuccess(), "Response should be successful");
assertNotNull(response.getData(), "Response data should not be null");
assertEquals(requestId, response.getData().getRequestId(), "Request ID should match");
assertNotNull(response.getData().getChoices(), "Response data should not be null");
assertFalse(response.getData().getChoices().isEmpty(), "Response data should not be empty");
assertNull(response.getError(), "Response error should be null");
logger.info("Synchronous chat completion response: {}", mapper.writeValueAsString(response));
}
@Test
@DisplayName("Test Asynchronous Chat Completion")
@EnabledIfEnvironmentVariable(named = "ZAI_API_KEY", matches = "^[^.]+\\.[^.]+$")