Skip to main content
Glama
CoveoSec
by CoveoSec

integrations_syslog_create

Create a syslog server integration to forward logs to an external syslog system, specifying address, port, protocol, and optional TLS security settings.

Instructions

Create a syslog integration

Create a new syslog integration.

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

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

Example request body:

{
  "request_data": {
    "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.
Behavior3/5

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

With no annotations, the description carries the transparency burden. It provides the permission requirement and shows an example request body, but it does not disclose the return value, idempotency, duplicate handling, or error behavior. This is a moderate level of disclosure for a creation endpoint.

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

Conciseness3/5

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

The description is not overly long but includes redundancy: 'Create a syslog integration' is immediately repeated as 'Create a new syslog integration.' The rest—permission, endpoint, and example—is useful, but the duplicate opening wastes space.

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

Completeness3/5

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

The tool has nested objects and protocol options, and the example covers a TLS case. However, with no output schema, the description does not explain what response to expect after creation, nor common error conditions. This leaves some practical gaps for an agent.

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

Parameters4/5

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

The schema covers 100% of parameters, so the baseline is 3. The description adds a concrete example request body that illustrates real values and the nested structure, which helps clarify how the abstract schema fields are used in practice.

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 clearly states the tool's function with a specific verb and resource: 'Create a syslog integration.' It distinguishes itself from sibling tools like integrations_syslog_get, update, delete, and test by focusing on creation.

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?

It provides the required permission ('View/Edit Alert Notification') and implies when to use the tool (to create a new syslog integration). It does not explicitly mention alternatives, but the context is clear enough for this create operation.

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