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 2 min

gx.yml reference

Every field in gx.yml, the Glxymesh project file that sets the organization, project, language, server identity and defaults for every tool.

gx.yml sits at the root of a project. There’s exactly one per project, and gxmesh init writes it.

gx.yml
spec: glxymesh/project@v1
org: acme
project: helpdesk
lang: node


server:
  title: Acme Helpdesk
  description: Support desk tools for Acme agents
  website: https://acme.com


defaults:
  timeout: 10s
  memory: 256MB
  output: json

New to YAML? Follow Understand gx.yml and templates for an annotated project and a complete HTTP tool. gx.yml is project configuration; request templates belong in each tool’s tool.yml.

Fields

Section titled “Fields”
Field Required What it does
spec no glxymesh/project@v1
org yes The organization’s slug. A push to a different organization is refused.
project yes The project’s slug. Together with org it sets the address, https://<org>.mcp.glxymesh.com/<project> (the default project is the host itself), and the server name clients show, <org>-<project>.
lang yes go, node or python. Every function tool in the project uses it.
server.title no The name clients show next to the server. Up to 80 characters.
server.description no One line on what the server is for, up to 500 characters. Clients show it, and the model reads it when it connects.
server.website no An https:// link clients may show.
defaults.timeout no Time per call for tools that don’t set their own, such as 10s or 2m. 1 second to 15 minutes. Default 10s.
defaults.memory no Memory for tools that don’t set their own, such as 256MB or 1GB. 128 MB to 10 GB.
defaults.output no toon, json or text: the format the model reads results in. See output.

server.title, server.description and server.website can also be set in the console under Settings → Server identity. Whichever changed last wins.

Slugs are 1–40 characters of a-z, 0-9 and single hyphens, not at either end. A few words the platform uses in its own paths, such as api, docs, mcp and support, aren’t allowed.

What’s not in it

Section titled “What’s not in it”
  • Keys. They live in the project’s secrets, set in the console, or for local runs in .env.local. See Keys and network access.
  • The list of tools. The folders under tools/ are the list.
  • Where things run. The platform decides.

Memory and your bill

Section titled “Memory and your bill”

Every function tool in a project runs in the same function, so the project’s memory is the largest that any of its tools asks for. A tool that sets limits.memory: 1GB raises the memory, and the compute cost, of every call in the project. Move a tool that needs a lot of memory to its own project.

© 2026 Glxymesh