Skip to main content
Glama
RPasquale

lightbulb-mcp

by RPasquale
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Python
Remote

register_external_artifact

Register an external artifact (e.g., document, code) with Lightbulb so agents can discover and use it. Specify type, URI or content, and optional metadata.

Instructions

Register an external artifact created outside Lightbulb so agents can discover it.

Args: type: Artifact class, for example codebase, document, spreadsheet, slide_deck, or url. title: Human-readable artifact title. uri: Optional external URL or repository URI. content: Optional inline artifact content when no URI exists. source_agent: Optional originating agent name. project_id: Optional Lightbulb project id to attach the artifact to. metadata: Optional JSON object with additional fields. attach_workspace: For codebase artifacts, also request a Code Workspace attachment.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
uriNo
typeYes
titleYes
contentNo
metadataNo
project_idNo
source_agentNo
attach_workspaceNo

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed5 schema fields changedv0.1.1
    • addedInput schema / properties / metadata
      Added value: +{
+  "default": "",
+  "title": "Metadata",
+  "type": "string"
+}
    • changedInput schema / properties / source_agent / default
      Previous value: -"external_agent"New value: +""
    • removedInput schema / properties / summary
      Removed value: -{
-  "default": "",
-  "title": "Summary",
-  "type": "string"
-}
    • removedInput schema / properties / title / default
      Removed value: -""
    • changedInput schema / required
      Previous value: -[
-  "type"
-]New value: +[
+  "type",
+  "title"
+]
  2. First observedv0.1.0

TDQS

A3.7/5.0
Behavior2/5

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

No annotations are provided, so the description must carry the full transparency burden. It mentions registration and discoverability but does not disclose side effects such as record creation, storage, workspace attachment behavior, idempotency, or permissions.

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 with a two-part structure (summary + arg list) and no redundant prose. Every sentence adds information.

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?

It covers the basic call but omits edge cases: whether uri or content is required, valid type enum values, project_id prerequisites, and exact return behavior (though an output schema exists). Agents may need additional details for correct invocation in all scenarios.

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 has zero descriptions, but the description explains all eight parameters with added context: type examples, uri/content relationship, and attach_workspace condition. Some values (metadata, type) remain underspecified, but the description largely compensates for the schema gap.

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 uses a specific verb ('register') and object ('external artifact created outside Lightbulb'), and states the purpose ('so agents can discover it'). This clearly distinguishes it from sibling list/get and create tools.

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 phrase 'created outside Lightbulb' implies when to use this tool, but it does not explicitly contrast with sibling create_document/create_spreadsheet or list_artifacts, nor provide when-not-to-use guidance. Usage guidance is present but only implicit.

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