Skip to main content
Glama
Sign In
Gatewerk

Gatewerk

Official
by gatewerk
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Remote

gatewerk_create_note

Create Markdown notes with tags and pin them to reviews, templates, or chain runs for clear documentation and follow-up.

Instructions

Create a note. api_key callers MUST set is_shared=true (or omit; default is true) — private notes are session-only. Notes can be pinned to one or more review/template/chain_run targets via attachments[].

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "body": "<body>"
    },
    "name": "gatewerk_create_note"
  }
}

Input Schema

NameRequiredDescriptionDefault
bodyYesNote body (Markdown supported)
tagsNoTags for categorization (e.g., ['risk', 'follow-up'])
is_sharedNoWhether the note is visible to other reviewers. Default true. api_key subjects MUST leave true (private notes are session-only).
project_idNoProject ID. session callers must pass; api_key callers may omit (server resolves from the key).
attachmentsNoTargets to pin this note to on creation

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.7/5.0
Behavior3/5

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

With no annotations, the description carries the full burden. It discloses key behavioral traits like session-only private notes and mandatory is_shared for api_key callers, but omits return values, potential errors, or permission requirements.

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 concise and front-loaded: three short sentences covering purpose, critical constraint, and attachment capability. Every sentence adds value with no redundancy.

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?

For a create tool with no output schema, the description explains the core functionality and key constraints but does not mention the return value or error handling. It is adequate but leaves some gaps.

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?

Schema coverage is 100% with detailed descriptions for all parameters. The description adds a summary of constraints but does not go beyond the schema's already thorough parameter documentation.

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 'Create a note' and adds distinguishing details about shared vs. private notes and attachment targets, differentiating it from sibling tools like list_notes. The verb and resource are specific.

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 essential usage context, such as api_key callers needing is_shared=true and the ability to pin notes via attachments, but it does not explicitly mention when to use this tool over alternatives or any exclusions.

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

Deploy Server

Other Tools