Skip to main content
Glama
CoveoSec
by CoveoSec

integrations_syslog_test

Test syslog server connectivity and validate integration settings. Ensure the syslog integration is correctly configured and reachable.

Instructions

Test syslog integration

Tests a syslog integration's validity.

You must have View Alert Notification permissions to run this endpoint.

[POST /public_api/v1/integrations/syslog/test] · Syslog servers

Example request body:

{
  "request_data": {
    "syslog_id": "123456789",
    "name": "Test PAPI",
    "address": "34.24.11.16",
    "port": "1234",
    "protocol": "TLS",
    "facility": "FAC_USER",
    "security_info": {
      "certificate_name": "wf-verdict-service.key.pem",
      "ignore_cert_errors": false,
      "certificate_content": "<binary string of the cert>"
    }
  }
}

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
request_dataYesA dictionary containing the API request fields.
Behavior2/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

No annotations are provided, so the description carries the full burden of behavioral disclosure. It mentions required permissions but does not explain whether the test sends data, validates certificates, saves anything, or what the response indicates. This leaves significant ambiguity about the tool's side effects and outcome.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is well-structured and concise, with a clear title, one-sentence purpose, permission note, endpoint, and a full example. The example is long but directly useful, with no filler sentences.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Although the schema thoroughly covers parameters, the description lacks information about return values (no output schema) and the exact behavior of the test (e.g., whether it attempts a network connection or sends a test message). For a tool with no annotations and no output schema, this is a meaningful gap.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The input schema provides 100% coverage with detailed descriptions for every field, so the baseline is 3. The example request body illustrates the structure but adds no new semantic meaning beyond what the schema already documents.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description explicitly states 'Tests a syslog integration's validity' with a clear verb and resource. It distinguishes the tool from sibling syslog tools (create/update/get/delete) by emphasizing the testing action. The example request body further clarifies the tool's scope.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides clear context that this tool is for testing syslog integration validity and includes a permission prerequisite. It does not explicitly mention alternatives or when-not-to-use, but the context is strong enough to guide an agent, giving it a 4 rather than a 5.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/CoveoSec/xsiam-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server