Install the stable packages and authenticate the CLI first:
npm install --global @teamgrid/cli@1.1.0 @teamgrid/mcp-server@1.1.0
teamgrid auth login
teamgrid auth status --check
Codex CLI, app, and IDE extension
Add the server from a terminal:
codex mcp add teamgrid -- teamgrid-mcp --profile default --tool-profile core
Equivalent configuration in ~/.codex/config.toml:
[mcp_servers.teamgrid]
command = "teamgrid-mcp"
args = ["--profile", "default", "--tool-profile", "core"]
startup_timeout_sec = 10
tool_timeout_sec = 60
Codex surfaces share this configuration. Restart an already-running host after adding the server, then verify that the TeamGrid tools are available.
Generic MCP host
Hosts that use JSON configuration commonly accept this stdio shape:
{
"mcpServers": {
"teamgrid": {
"command": "teamgrid-mcp",
"args": ["--profile", "default", "--tool-profile", "core"]
}
}
}
The exact settings location and configuration key depend on the host. Consult its current MCP documentation.
Ephemeral environment
The process may receive TEAMGRID_API_TOKEN, TEAMGRID_API_BASE_URL, and
TEAMGRID_MCP_TOOL_PROFILE. Prefer the shared operating-system keychain profile for local desktop
use. If a host cannot isolate environment variables or redact logs reliably, do not inject a
credential into it.
The server communicates over standard input/output. It does not listen on a TCP port.
It does not open a browser. Complete teamgrid auth login in a terminal first. An unattended MCP
process must use a service-account credential rather than a personal browser credential.
Narrow the advertised tools
The selected profile is an upper bound. Repeat --allow-tool to keep only exact registered names,
or --deny-tool to remove exact names. Comma-separated values are accepted. An allow list cannot
enable a tool outside the profile, unknown names fail startup, and overlapping allow/deny entries
are rejected.
teamgrid-mcp --profile default --tool-profile core \
--allow-tool teamgrid_workspace_get,teamgrid_projects_list
For isolated process environments, TEAMGRID_MCP_ALLOW_TOOLS and
TEAMGRID_MCP_DENY_TOOLS provide the same narrowing controls. Tool filters do not grant API scopes
and cannot register a write or secret-bearing operation.
Verify the connection
After restarting the host:
- Confirm that a server named
teamgridis connected without a startup error. - Ask the host to list TeamGrid tools and verify that the selected tool profile is reflected.
- Run a bounded read such as workspace discovery before enabling any write-capable profile.
- Confirm that the returned workspace and region match the intended credential.
If the server does not start, run teamgrid auth status --check in the same operating-system user
session and then run teamgrid-mcp --profile default --tool-profile core in a terminal. A JSON-RPC
stdio server normally waits silently for host input; an authentication or configuration error is
printed before that wait. Check that the host inherits the same PATH used by the terminal and that
Node.js satisfies the supported range in versions and compatibility.
Do not select a broader tool profile merely to diagnose a connection problem. Tool availability is an authorization boundary in addition to the scopes held by the credential.
Continue with the first MCP query, look up the exact contract in the MCP tool reference, or diagnose a failure with the MCP troubleshooting matrix.