Skip to main content
Glama
CoveoSec
by CoveoSec

integrations_syslog_update

Update a syslog integration's settings, such as name, address, port, protocol, and security info. Modify an existing syslog server configuration to ensure accurate log forwarding.

Instructions

Update a syslog integration

Update the details of the specified syslog integration.

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

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

Example request body:

{
  "request_data": {
    "syslog_id": "123456789",
    "name": "Test PAPI",
    "address": "35.27.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 must communicate behavioral traits. It discloses the permission requirement and the endpoint path, but it does not describe whether the update is partial or full, what response to expect, or any side effects or failure modes. This leaves the agent with significant unknowns for a mutation operation.

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 opens with two redundant statements: 'Update a syslog integration' and 'Update the details...'. The example body is long and duplicates schema information. While the permission note is useful, the overall structure could be tighter and more front-loaded.

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?

For an update tool with no output schema and no annotations, the description should explain the update behavior (full vs partial), the response format, and potential errors. The schema covers field semantics, but the description omits these essential behavioral details, making it incomplete for an agent to confidently invoke the tool.

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, including the protocol enum and security_info nuances. The description's example request body adds little beyond the schema since it merely repeats field names and values. Baseline 3 is appropriate because the schema does the heavy lifting.

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 purpose: 'Update a syslog integration' and 'Update the details of the specified syslog integration.' It identifies the resource (syslog integration) and the action (update), distinguishing it from sibling tools like create, get, delete, and test.

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

Usage Guidelines3/5

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

The description provides context by stating the required permission ('You must have View/Edit Alert Notification permissions') and showing an example request, but it does not explicitly contrast with alternatives like create or test, nor does it state when not to use this tool. Usage is implied rather than explicitly guided.

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