Skip to main content
Glama
MarwanDevSpace

mcp-garry-codes

by MarwanDevSpace
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Local

Get Exact GMod Symbol Documentation

get_gmod_symbol
Read-onlyIdempotent

Fetch complete API docs for any known Garry's Mod symbol: parameters, return types, realm, and caveats. Get authoritative answers directly from the Facepunch Wiki index.

Instructions

Retrieve authoritative, complete API documentation for a specific, known Garry's Mod symbol (function, hook, library method, panel, or class) from the Facepunch Wiki index. Read-only lookup operation with zero side effects, no authentication required, and instant indexed retrieval; does NOT modify the workspace. If the symbol is not found in the index, returns status 'failed' with data null and provides actionable search alternatives in nextActions. Requires an exact, case-sensitive or standard symbol identifier (e.g. 'net.Receive', 'surface.DrawPoly', 'GM:PlayerInitialSpawn', 'Entity:TakeDamage'). Set include_examples to false (defaults to true) to exclude code examples and reduce token consumption. Use this tool when you know the exact symbol name and require complete parameter specifications, return types, engine caveats, realm affinity, or code examples. Do NOT use for keyword or topic searches (use search_gmod_wiki instead). Do NOT use for third-party addon code or community forum workarounds (use web_search_glua instead). Returns a GModToolResult envelope with status ('success' or 'failed'), summary, and data containing symbol, realm, description, arguments array (name, type, optional, default, description), returns array, examples array, notes, warnings, and canonical wiki_url.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
symbolYesExact case-sensitive or standard Garry's Mod symbol name (e.g. 'util.AddNetworkString', 'net.Receive', 'GM:PlayerInitialSpawn', 'surface.DrawPoly', 'Entity:TakeDamage').
include_examplesNoWhether to include official Lua code usage examples in the response (default is true; set false to reduce token payload).

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
dataYesDomain-specific typed payload returned by the tool.
statusYesExecution status of the tool call ('success', 'partial', 'blocked', or 'failed').
summaryYesConcise, human-readable summary of operational findings, diagnostics, or execution outcome.
evidenceYesTraceability evidence including cited documentation and generated artifacts.
warningsYesList of non-fatal warnings, lint advisories, engine caveats, or security notices.
nextActionsNoActionable, ordered recommendations for the agent's immediate next steps.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed4 schema fields changed
    • changedInput schema / properties / include_examples / description
      Previous value: -"Include official usage examples"New value: +"Whether to include official Lua code usage examples in the response (default is true; set false to reduce token payload)."
    • changedInput schema / properties / symbol / description
      Previous value: -"Exact symbol name (e.g. 'surface.DrawPoly', 'util.AddNetworkString')"New value: +"Exact case-sensitive or standard Garry's Mod symbol name (e.g. 'util.AddNetworkString', 'net.Receive', 'GM:PlayerInitialSpawn', 'surface.DrawPoly', 'Entity:TakeDamage')."
    • addedInput schema / properties / symbol / minLength
      Added value: +1
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
+  "properties": {
+    "data": {
+      "description": "Domain-specific typed payload returned by the tool.",
+      "properties": {
+        "arguments": {
+          "description": "Function arguments with types, optionality, defaults, and descriptions.",
+          "items": {
+            "properties": {
+              "default": {
+                "description": "Default value if omitted.",
+                "type": "string"
+              },
+              "description": {
+                "description": "Description of the parameter's role.",
+                "type": "string"
+              },
+              "name": {
+                "description": "Parameter name.",
+                "type": "string"
+              },
+              "optional": {
+                "description": "True if parameter is optional.",
+                "type": "boolean"
+              },
+              "type": {
+                "description": "GMod type (e.g. 'string', 'Player', 'number', 'table').",
+                "type": "string"
+              }
+            },
+            "required": [
+              "name",
+              "type",
+              "optional",
+              "description"
+            ],
+            "type": "object"
+          },
+          "type": "array"
+        },
+        "description": {
+          "description": "Official documentation description.",
+          "type": "string"
+        },
+        "examples": {
+          "description": "Official usage examples with runnable GLua code snippets.",
+          "items": {
+            "properties": {
+              "code": {
+                "description": "GLua example code.",
+                "type": "string"
+              },
+              "title": {
+                "description": "Example title or scenario.",
+                "type": "string"
+              }
+            },
+            "required": [
+              "title",
+              "code"
+            ],
+            "type": "object"
+          },
+          "type": "array"
+        },
+        "notes": {
+          "description": "Implementation notes and tips.",
+          "items": {
+            "type": "string"
+          },
+          "type": "array"
+        },
+        "realm": {
+          "description": "Execution realm affinity.",
+          "enum": [
+            "server",
+            "client",
+            "shared",
+            "menu"
+          ],
+          "type": "string"
+        },
+        "returns": {
+          "description": "Return values with types and descriptions.",
+          "items": {
+            "properties": {
+              "description": {
+                "description": "Description of what is returned.",
+                "type": "string"
+              },
+              "name": {
+                "description": "Return value identifier.",
+                "type": "string"
+              },
+              "type": {
+                "description": "Return type.",
+                "type": "string"
+              }
+            },
+            "required": [
+              "name",
+              "type",
+              "description"
+            ],
+            "type": "object"
+          },
+          "type": "array"
+        },
+        "symbol": {
+          "description": "Exact Garry's Mod symbol identifier.",
+          "type": "string"
+        },
+        "warnings": {
+          "description": "Engine caveats, edge cases, and known pitfalls.",
+          "items": {
+            "type": "string"
+          },
+          "type": "array"
+        },
+        "wiki_url": {
+          "description": "Canonical Facepunch Garry's Mod wiki URL.",
+          "type": "string"
+        }
+      },
+      "required": [
+        "symbol",
+        "realm",
+        "description",
+        "arguments",
+        "returns",
+        "examples",
+        "notes",
+        "warnings",
+        "wiki_url"
+      ],
+      "type": "object"
+    },
+    "evidence": {
+      "description": "Traceability evidence including cited documentation and generated artifacts.",
+      "properties": {
+        "artifacts": {
+          "description": "Files, packages, or manifests generated on disk or in memory.",
+          "items": {
+            "properties": {
+              "label": {
+                "description": "Descriptive label of the generated artifact.",
+                "type": "string"
+              },
+              "sha256": {
+                "description": "SHA-256 hash of the generated file.",
+                "type": "string"
+              },
+              "uri": {
+                "description": "File path or URI of the generated artifact.",
+                "type": "string"
+              }
+            },
+            "required": [
+              "label",
+              "uri"
+            ],
+            "type": "object"
+          },
+          "type": "array"
+        },
+        "inputsDigest": {
+          "description": "SHA-256 digest of normalized tool inputs for auditability.",
+          "type": "string"
+        },
+        "sources": {
+          "description": "Cited documentation, wiki pages, or external web sources supporting the result.",
+          "items": {
+            "properties": {
+              "label": {
+                "description": "Display name or title of the cited resource.",
+                "type": "string"
+              },
+              "retrievedAt": {
+                "description": "ISO-8601 timestamp of source retrieval.",
+                "type": "string"
+              },
+              "uri": {
+                "description": "Canonical URI or URL of the documentation or source.",
+                "type": "string"
+              }
+            },
+            "required": [
+              "label"
+            ],
+            "type": "object"
+          },
+          "type": "array"
+        }
+      },
+      "required": [
+        "sources",
+        "artifacts"
+      ],
+      "type": "object"
+    },
+    "nextActions": {
+      "description": "Actionable, ordered recommendations for the agent's immediate next steps.",
+      "items": {
+        "type": "string"
+      },
+      "type": "array"
+    },
+    "status": {
+      "description": "Execution status of the tool call ('success', 'partial', 'blocked', or 'failed').",
+      "enum": [
+        "success",
+        "partial",
+        "blocked",
+        "failed"
+      ],
+      "type": "string"
+    },
+    "summary": {
+      "description": "Concise, human-readable summary of operational findings, diagnostics, or execution outcome.",
+      "type": "string"
+    },
+    "warnings": {
+      "description": "List of non-fatal warnings, lint advisories, engine caveats, or security notices.",
+      "items": {
+        "type": "string"
+      },
+      "type": "array"
+    }
+  },
+  "required": [
+    "status",
+    "summary",
+    "data",
+    "warnings",
+    "evidence"
+  ],
+  "type": "object"
+}
  2. First observedv1.0.0

TDQS

A4.8/5.0
Behavior5/5

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

Even with readOnlyHint, idempotentHint, and destructiveHint annotations, the description clarifies 'Read-only lookup operation with zero side effects, no authentication required' and failure behavior: returns status 'failed' with data null and actionable nextActions. No contradiction with annotations.

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

Conciseness4/5

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

The description is longer than the minimum but organized: purpose, usage boundaries, failure behavior, and envelope. It slightly repeats schema defaults (include_examples default, symbol examples), but every section earns its place and the key constraints are front-loaded.

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

Completeness5/5

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

For a read-only lookup with an output schema, the description covers success and failure envelopes, realm, arguments, returns, examples, notes, warnings, and canonical wiki_url, plus siblings for alternate cases. Nothing necessary to select or invoke it correctly is missing.

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?

Schema coverage is 100%, so the baseline is 3. The description adds value by explaining that include_examples=false 'reduce[s] token consumption' and by emphasizing the exact/case-sensitive identifier requirement with examples, going slightly beyond the schema definitions.

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 opens with a specific action and resource: 'Retrieve authoritative, complete API documentation for a specific, known Garry's Mod symbol ... from the Facepunch Wiki index.' It also names sibling tools and what they are for, making it easy to distinguish from search_gmod_wiki and web_search_glua.

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

Usage Guidelines5/5

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

Explicit use case: 'Use this tool when you know the exact symbol name and require complete parameter specifications...' and explicit exclusions: 'Do NOT use for keyword or topic searches' and 'Do NOT use for third-party addon code...', each naming the alternative tool. This fully routes the agent.

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