Getting started

Quickstart

Connect a local MCP client, verify tool discovery and make one narrow request.

Swipe wide tables and code examples sideways to see the full content.

Swipe wide tables and code examples sideways to see the full content.

Your first goal is a working read-only request against one repository you already have permission to inspect. Complete the checks below in order so a missing credential is not mistaken for a client configuration problem.

Before you start

  • Choose an MCP client with local stdio server support.

  • Confirm Node.js and npx are available to the environment that launches your client.

  • Obtain an issue-tracker credential restricted to the repository you need.

  • Use the verified server package and version supplied by your operator. @toolport/mcp is the template package placeholder.

1. Register the server

Choose your client guide. CLI clients register a command; JSON clients describe the same command and arguments. The client starts Toolport as a local process. A copied example is configuration, not evidence that the server is installed or authenticated.

{
  "mcpServers": {
    "toolport": {
      "command": "npx",
      "args": ["-y", "@toolport/mcp"],
      "env": { "TOOLPORT_TOKEN": "REPLACE_WITH_LOCAL_SECRET" }
    }
  }
}

2. Verify discovery

Reload the MCP connection and inspect the tool list. Expect search_issues, get_issue, list_labels and list_milestones. If the process does not start, check the package, runtime and configuration first. If it starts but tools are missing, use the Missing tools guide.

3. Ask a focused question

Find open bugs in acme/sdk. Return at most 20 issues.

Inspect the proposed tool name and arguments before approving. The repository should be explicit; state should be open; label should be bug; limit should be 20. Read the returned count and truncated flag before treating the answer as complete.

Success check

  • The client reports the server as available.

  • The four expected tool names are visible.

  • One approved call returns a result or an actionable tool error.

  • No credential appears in your prompt, screenshot or committed config.

Make your first request

Create a free website with Framer, the website builder loved by startups, designers and agencies.