Skip to content
GlxymeshDocs
Get started: set up a projectInstall the gxmesh CLI, create a Glxymesh project in Go, TypeScript or Python, add a tool, run it locally, deploy it, and connect Claude Code.Learn the CLI step by stepUnderstand the gxmesh workflow from sign-in and project selection to scaffolding, local calls, tests, deployment and client connection.Understand gx.yml and templatesLearn YAML syntax, every project setting, tool definitions, input placeholders, secrets, network rules and tests through a complete HTTP tool.How Glxymesh runs your toolsOrganizations, projects and tools; the tool kinds; what happens on a tool call; OAuth 2.1 sign-in with no API keys; and the network rules every tool runs under.
Connect an MCP clientConnect Codex, Claude, Claude Code, VS Code, Cursor, Windsurf and other MCP clients to a Glxymesh project over Streamable HTTP with OAuth, step by step, and fix 401/404/405.
Build tools with AIDescribe a tool in plain language and let Ada write and check it in Mesh Builder, or have your own agent propose one, then review, test and publish it from the console.Build from GitHubTurn your own API's routes into MCP tools straight from its GitHub repository, and on Pro, keep them in step with every push.Tool kindsThe two kinds of Glxymesh tool, http and function, with a complete tool.yml for each and when to use which.Develop locallyRun every tool in a Glxymesh project on your machine with gxmesh dev, call tools from the terminal, run their tests, and connect a local MCP client.Deploy and roll backWhat gxmesh push does, approving new hosts and keys, the tests that run before a revision goes live, revisions, rollbacks, and watching calls.Keys and network accessHow Glxymesh tools reach external APIs, how new hosts are approved, and how API keys are added on the way out so tool code never holds them.Connect to a databaseReach Postgres, MySQL, Redis, MongoDB and other TCP services from a Glxymesh function tool, with the address approved in tool.yml and the password passed in from the vault.Project layoutEvery file in a Glxymesh project for Go, TypeScript and Python, who writes it, whether to commit it, and the naming rules the CLI enforces.
gxmesh CLI referenceEvery gxmesh CLI command for Glxymesh projects: login, org and project scope, init, pull, new, gen, dev, call, test, push, revisions, rollback, connect, update, uninstall and env vars.gx.yml referenceEvery field in gx.yml, the Glxymesh project file that sets the organization, project, language, server identity and defaults for every tool.tool.yml referenceEvery field in tool.yml, the Glxymesh tool file, for http and function tools, with input types, output formats, network, keys, limits and tests.SDK referenceThe ctx object every Glxymesh function tool receives, in Go, TypeScript and Python, for outbound HTTP, key placeholders, logs, the caller, the deadline and errors.LimitsLimits for Glxymesh projects and tools: tool.yml sizes, time and memory per call, outbound requests, push size, sleep and keeping tools awake.
Open the consoleplatform.glxymesh.comGo to glxymesh.comwww.glxymesh.com
↑↓ navigate↵ openCtrl↵ new tabesc close
glxymesh.com
Select theme
Open console
Reading time 3 min

Project layout

Every file in a Glxymesh project for Go, TypeScript and Python, who writes it, whether to commit it, and the naming rules the CLI enforces.

A project is one directory. gx.yml sits at the root, and each tool is one folder under tools/. Only two things change with the language: the package files at the root and the code in each function tool’s folder.

  • Directoryacme-helpdesk/
    • gx.yml
    • package.json
    • pnpm-lock.yaml once package.json lists packages
    • tsconfig.json
    • Directorylib/ optional code shared by several tools
      • …
    • Directorytools/
      • Directoryget-weather/
        • tool.yml an http tool: no code
      • Directorylist-open-issues/
        • tool.yml
        • tool.ts export async function run(ctx, input)
        • tool.gen.ts generated Input type
    • .env.local
    • Directory.glxy/
      • …
    • .gitignore

What each file is

Section titled “What each file is”
File What it holds Written by Commit
gx.yml Organization, project, language, server name and description, defaults. See the reference. gxmesh init, then you Yes
package.json · go.mod Packages for every tool in the project You, or pnpm add · go get Yes
pnpm-lock.yaml · go.sum Exact package versions and hashes. In Go, the platform fills in go.sum if you leave it out. Your package manager Yes
requirements.txt Python packages, each pinned to one version with its hashes. Each needs a wheel for Linux arm64 and Python 3.14: no source package is built. uv pip compile requirements.in --generate-hashes --python-version 3.14 --python-platform aarch64-manylinux_2_34 -o requirements.txt Yes
tools/<name>/tool.yml Name, kind, description, inputs, allowed hosts, keys, limits, tests. See the reference. gxmesh new, then you, or Glxymesh’s AI Yes
tool.ts · *.go in a tool’s folder The run function of a function tool, and its helpers You Yes
lib/ · internal/ Code shared by several tools You Yes
tool.gen.ts · input_gen.go Typed inputs generated from tool.yml. Never edit them. gxmesh gen, which dev, call and test also run Yes
.env.local Keys for local runs only, as NAME=value You No
.glxy/ The SDK copy, the local build and caches. Safe to delete. gxmesh No

Packages are declared once per project, not per tool, because every function tool in a project runs in the same function.

A push sends only these files. Anything else in the directory, such as a README or test fixtures, stays on your machine.

What each kind of tool needs

Section titled “What each kind of tool needs”
Kind Files in its folder
http tool.yml only. A code file beside it fails the push, because nothing would run it.
function tool.yml, the code, and the generated input file

Naming rules

Section titled “Naming rules”
  • The file is tool.yml, exactly. A tool.yaml is reported with a message telling you to rename it, rather than the folder being skipped silently.
  • A tool’s folder name is its name: 1–64 characters of a-z, 0-9 and -, such as list-open-issues. The name: in tool.yml must match it.
  • In Go, the package is the name without hyphens: listopenissues. In Python, the folder is loaded as a package of its own, so from .tool_gen import Input works with the hyphen.
  • The project and organization slugs are 1–40 characters of a-z, 0-9 and single hyphens. A few words the platform uses itself, such as api, docs and support, aren’t allowed.
© 2026 Glxymesh