Skip to main content
Glama

github_publish_start

Destructive

Initiate a dashboard-tracked GitHub publish: commit already-staged changes, push without force, and monitor GitHub Actions in the background.

Instructions

Start a dashboard-tracked GitHub publish: optionally commit already-staged changes, push without force, then monitor GitHub Actions in the background. This never runs git add. Use job_wait once if the workflow should continue automatically after publishing.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
cwdYesWorking tree or a directory inside it.
branchNoDestination branch. Defaults to the current branch.
remoteNoGit remote to push without force.origin
githubTokenNoOptional memory-only GitHub token override. By default RunBeacon safely reuses Git Credential Manager for private repositories and API limits.
watchActionsNoDiscover and monitor GitHub Actions after the push. Disable for non-GitHub remotes.
commitMessageNoWhen present, commit only changes that are already staged. The tool never runs git add.
idempotencyKeyNoStable key that prevents a retry from creating another commit or push job.
pollIntervalMsNoBackground API interval. Anonymous GitHub API access is automatically limited to at least 60 seconds.
requireActionsNoFail the publish job when no eligible workflow exists or Actions monitoring is unavailable. Actual workflow failures always fail the job.
actionsTimeoutMsNo
credentialProfileNoOptional saved GitHub profile that reuses Git Credential Manager without exposing its token. When omitted, the default GitHub profile is selected unless githubToken is supplied.
discoveryTimeoutMsNo
Behavior4/5

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

Annotations already mark this as destructive and non-idempotent. The description adds important behavioral details: it only commits already-staged changes, pushes without force, and monitors in the background. It also mentions the never-runs-git-add rule, giving the agent a clear mental model beyond the annotations.

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 two sentences, front-loaded with the core action, and every phrase adds value. It packs the key workflow, safety constraint, and cross-tool referral without wasted words.

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?

While the description explains the high-level process, it does not clarify what the tool returns (e.g., a job ID) or how the agent should interpret the outcome. Given there is no output schema, the missing return-value information is a notable gap, though the instruction to use job_wait partially compensates by implying a follow-up mechanism.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The schema already covers 83% of parameter descriptions, so the baseline is 3. The description adds context around the commitMessage and remote parameters by mentioning 'commit already-staged changes' and 'push without force', but it doesn't substantially augment the schema's parameter documentation.

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 clearly states the tool starts a dashboard-tracked GitHub publish process: optionally commit staged changes, push without force, and monitor GitHub Actions in the background. This distinguishes it from sibling tools like job_start by specifying the GitHub publish workflow and the key constraint of never running git add.

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

Usage Guidelines4/5

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

Provides practical usage guidance: 'This never runs git add' clarifies an important limitation, and 'Use job_wait once if the workflow should continue automatically after publishing' directs the agent to a specific next step. It does not explicitly list when to use alternatives, but the workflow context and sibling hints give clear enough direction.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/Liyuchen0118/RunBeacon'

If you have feedback or need assistance with the MCP directory API, please join our Discord server