Skip to main content
Glama

create_sn_integration_artifacts

Creates all required ServiceNow artifacts for a bidirectional integration: correlation table, retry table, sync flags, REST message, business rule, scripted API, UI action, and client script.

Instructions

Create all ServiceNow-side artifacts for a bidirectional integration:

  • Correlation table (cross-platform ID tracking)

  • Retry/error table (dead-letter queue for failed syncs)

  • Sync-in-progress flag field (loop prevention)

  • sys_properties entry (field mapping config)

  • Outbound REST Message + HTTP method (for SN→external calls)

  • Business Rule (fires on record change, calls outbound REST)

  • Scripted REST API + POST operation (inbound endpoint for external→SN)

  • UI Action "Sync Now" button

  • Client Script (shows sync status on form)

Requires the integration plan from design_integration.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
planYesThe plan object returned by design_integration
target_urlNoBase URL of the target platform API (e.g. https://your-domain.atlassian.net)
target_api_keyNoAPI key or token for the target platform (stored in Named Credentials later)
Behavior4/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. It transparently lists all 9 artifacts created, implying significant system modifications. It does not contradict any annotations, and the detailed list gives the agent clear expectations about the tool's impact.

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

Conciseness5/5

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

The description is a well-structured bullet list that front-loads the purpose and lists all artifacts concisely. Every sentence adds value; no filler. The one-sentence usage note at the end is efficient.

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

Completeness4/5

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

Given the complexity (creating 9 artifacts) and the absence of an output schema, the description thoroughly explains what is created. It might be improved by mentioning the return value or success confirmation, but overall it is complete enough for an agent to understand the tool's effect.

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

Parameters5/5

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

Schema coverage is 100%, but the description adds critical context beyond the schema: it explains that 'plan' must come from design_integration, 'target_url' is the base URL of the target platform API, and 'target_api_key' is an API key for the target platform. This significantly enriches the parameter meaning.

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 'Create all ServiceNow-side artifacts for a bidirectional integration' and lists every artifact type (correlation table, retry/error table, etc.). This clearly distinguishes it from sibling tools like 'create_sf_integration_artifacts' or 'create_jira_integration_artifacts' by focusing specifically on the ServiceNow side.

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 includes 'Requires the integration plan from design_integration,' which provides clear context for when this tool should be used (after design integration). However, it does not explicitly mention when not to use it or suggest alternative tools.

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/pinnintisagarSB/ServiceNow-Dev-MCP'

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