TLS
STDIOTLS日志分析自然语言转换MCP服务器
TLS日志分析自然语言转换MCP服务器
The official MCP Server for the logging service can accurately convert natural language into log analysis statements, enabling efficient log analysis. It is easy to use, quick to get started, and suitable for scenarios such as operations troubleshooting and data analysis, unlocking the unlimited potential of the logging service for you.
| Version | v0.1.0 |
|---|---|
| Description | A new experience of natural language-driven log analysis |
| Category | Cloud Basics - Storage |
| Tags | Logs, Observability, Data Flywheel |
This tool allows you to search logs using various query types, including full-text search, key-value search, and SQL queries. It provides flexible time range filtering and limit options to customize search results. The default time range is 15 minutes.
Input
{ "inputSchema": { "type": "object", "required": ["query"], "properties": { "query": { "type": "string", "description": "Log query statement" }, "topic_id": { "type": "string", "description": "Optional log topic ID. Defaults to the topic_id set in the environment variable. If not set, this is required." }, "start_time": { "type": "integer", "description": "Query start time, Unix timestamp (seconds/milliseconds)" }, "end_time": { "type": "integer", "description": "Query end time, Unix timestamp (seconds/milliseconds)" }, "limit": { "type": "integer", "description": "Maximum number of logs to return, default is 10" } } }, "name": "search_logs_v2", "description": "Query logs within a specified log topic and time range based on a log query statement" }
Output
{ "result_status": "complete", "hit_count": 1, "list_over": false, "analysis": false, "count": 1, "limit": 10, "context": "", "logs": [ { "__container_ip__": "127.0.0.1", "__container_name__": "tls container name", "__content__": "log content", "__context_flow__": "", "__image_name__": "image name", "__namespace__": "namespace", "__package_offset__": "package offset", "__path__": "your log path", "__pod_name__": "tls pod name", "__pod_uid__": "tls pod uid", "__source__": "your ip", "__tag____client_ip__": "client ip", "__tag____receive_time__": "log receive time", "__time__": 1745029622660 } ], "analysis_result": { "analysis_schema": [], "analysis_type": {}, "analysis_data": [] }, "elapsed_millisecond": 666 }
Use the search_logs_v2_tool to query the top 10 logs with the query "content: error".
Converts user input queries into TLS-defined SQL query statements. If the query is ambiguous, further clarification may be requested.
Input
{ "inputSchema": { "type": "object", "required": ["question"], "properties": { "question": { "type": "string", "description": "User input query language" }, "topic_id": { "type": "string", "description": "Optional log topic ID. Defaults to the topic_id set in the environment variable. If not set, this is required." }, "session_id": { "type": "string", "description": "Optional session ID for TLS Copilot" } } }, "name": "text2sql", "description": "Converts user input queries into TLS-defined SQL query statements" }
Output
{ "answer": "AI-generated response, including reasoning process", "Suggestions": ["AI-generated suggestions, such as clarifications for ambiguous queries"], "session_id": "Session ID returned by the server for the current TLS Copilot session" }
Use the text2sql tool to generate an SQL query to count logs where the "content" field contains "error".
Retrieve project information for a specified project ID under the current permissions.
Input
{ "inputSchema": { "type": "object", "required": [], "properties": { "project_id": { "type": "string", "description": "Optional log project ID. Defaults to the project_id set in the environment variable. If not set, this is required." } } }, "name": "describe_project_tool", "description": "Retrieve project information for a specified project ID under the current permissions" }
Output
{ "project_name": "your project_name", "project_id": "your project id", "description": "your project description", "create_time": "2025-04-18 18:00:00", "inner_net_domain": "https://tls-cn-beijing.ivolces.com", "topic_count": 1, "iam_project_name": "default", "tags": null, "public_net_domain": "https://tls-cn-beijing.volces.com", "cs_account_channel": "" }
Use the describe_project_tool to find the project name for project_id xxx.
Retrieve information for multiple projects under the current permissions.
Input
{ "inputSchema": { "type": "object", "required": [], "properties": {} }, "name": "describe_projects_tool", "description": "Retrieve information for multiple projects under the current permissions" }
Output
{ "total": 1, "projects": [ "project_name": "your project_name", "project_id": "your project id", "description": "your project description", "create_time": "2025-04-18 18:00:00", "inner_net_domain": "https://tls-cn-beijing.ivolces.com", "topic_count": 1, "iam_project_name": "default", "tags": null, "public_net_domain": "https://tls-cn-beijing.volces.com", "cs_account_channel": "" ] }
Use the describe_projects_tool to find the names of the first 10 projects.
Retrieve topic information for a specified topic ID under the current permissions.
Input
{ "inputSchema": { "type": "object", "required": [], "properties": { "topic_id": { "type": "string", "description": "Optional log topic ID. Defaults to the topic_id set in the environment variable. If not set, this is required." } } }, "name": "describe_topic_tool", "description": "Retrieve topic information for a specified topic ID under the current permissions" }
Output
{ "topic_name": "your topic name", "topic_id": "your topic id", "project_id": "your project id", "ttl": 30, "create_time": "2022-06-22 16:05:27", "modify_time": "2025-03-10 17:19:54", "shard_count": 6, "description": "", "auto_split": false, "max_split_shard": 0, "enable_tracking": false, "time_key": "", "time_format": "", "tags": null, "log_public_ip": true, "enable_hot_ttl": false, "hot_ttl": 0, "cold_ttl": 0, "archive_ttl": 0 }
Use the describe_topic_tool to find the shard count for the current topic.
Retrieve information for multiple topics under a specified project ID within the current permissions.
Input
{ "inputSchema": { "type": "object", "required": [], "properties": { "project_id": { "type": "string", "description": "Optional log project ID. Defaults to the project_id set in the environment variable. If not set, this is required." } } }, "name": "describe_topics_tool", "description": "Retrieve information for multiple topics under a specified project ID within the current permissions" }
Output
{ "total": 1, "topics": [ { "topic_name": "your topic name", "topic_id": "your topic id", "project_id": "your project id", "ttl": 30, "create_time": "2022-06-22 16:05:27", "modify_time": "2025-03-10 17:19:54", "shard_count": 6, "description": "", "auto_split": false, "max_split_shard": 0, "enable_tracking": false, "time_key": "", "time_format": "", "tags": null, "log_public_ip": true, "enable_hot_ttl": false, "hot_ttl": 0, "cold_ttl": 0, "archive_ttl": 0 } ] }
Use the describe_topics_tool to find the shard count for the first 10 topics under the current project.
Can be used with cline, cursor, Claude desktop, or other terminals supporting MCP server calls.
Activate TLS Service. Users who have not activated the service will be redirected to the activation page. If already activated, they will be redirected to the homepage.
API Key (Signature Mechanism)
mv .env_example .env
Set relevant environment variables in the .env file.
For local deployment, set PROJECT_ID, TOPIC_ID, ACCOUNT_ID, etc., as default parameters for the tools.
For server-based deployment, set DEPLOY_MODE=remote and only configure REGION and ENDPOINT.
{ "mcpServers": { "tls": { "command": "uv", "args": [ "--directory", "/ABSOLUTE/PATH/TO/PARENT/FOLDER/src/mcp_server_tls", "run", "main.py" ] } } }
{ "mcpServers": { "tls": { "command": "uvx", "args": [ "--from", "git+https://github.com/volcengine/mcp-server#subdirectory=server/mcp_server_tls", "mcp-server-tls" ], "env": { "AK": "your ak", "SK": "your sk", "REGION": "your region", "ENDPOINT": "your endpoint", "ACCOUNT_ID": "your account id", "PROJECT_ID": "your project id", "TOPIC_ID": "your topic id" } } } }
Set DEPLOY_MODE=remote.
uv --directory /ABSOLUTE/PATH/TO/PARENT/FOLDER run mcp-server-tls -t sse
When used by the caller, authentication information should be base64-encoded and included in the request header as authorization:
{ "AccessKeyId": "your ak", "SecretAccessKey": "your sk", "SessionToken": "your token" }
volcengine/mcp-server is licensed under the MIT License.