teamform-mcp-server
TypeScript icon, indicating that this package has built-in type declarations

0.0.5 • Public • Published

TeamForm MCP Server

A Model Context Protocol (MCP) server that enables AI assistants to interact with your TeamForm organization data.

What It Does

This MCP server provides 8 tools that allow AI assistants (like Claude Desktop) to:

  • Search and retrieve people from your TeamForm organization
  • Search and retrieve teams with optional membership and tag information
  • Get team tags and applied counts
  • Retrieve objectives with parent objective relationships
  • Filter data by workspace and historical dates
  • Include related data like memberships, tags, and parent objects when requested
  • Search for tags and see how many times they are applied
  • Find all people or teams with a specific tag

Installation

Install the package globally using npm:

npm install -g teamform-mcp-server

Configuration

You'll need your TeamForm API credentials. You can configure the server in two ways:

Option 1: Command Line Arguments (Recommended)

teamform-mcp-server \
  --tenant-id "your_tenant_id" \
  --client-id "your_client_id" \
  --client-secret "your_client_secret"

Option 2: Environment Variables

Create a .env file with your credentials:

TEAMFORM_TENANT_ID=your_tenant_id
TEAMFORM_CLIENT_ID=your_client_id
TEAMFORM_CLIENT_SECRET=your_client_secret

Then run: teamform-mcp-server

Optional Settings:

  • --api-base-url or TEAMFORM_API_BASE_URL (default: https://api.teamform.co)
  • --auth-url or TEAMFORM_AUTH_URL (default: https://orchestrated-integration.au.auth0.com/oauth/token)

Usage with Claude Desktop

macOS Setup

  1. Open the Claude Desktop configuration file:

    nano "~/Library/Application Support/Claude/claude_desktop_config.json"
  2. Add the MCP server configuration:

    {
      "mcpServers": {
        "teamform": {
          "command": "teamform-mcp-server",
          "args": [
            "--tenant-id",
            "your_tenant_id",
            "--client-id",
            "your_client_id",
            "--client-secret",
            "your_client_secret"
          ]
        }
      }
    }
  3. Restart Claude Desktop

Windows Setup

  1. Open the configuration file at: %APPDATA%\Claude\claude_desktop_config.json

  2. Add the same configuration as above

  3. Restart Claude Desktop

Available Tools

Once connected, Claude will have access to these TeamForm tools:

Tool Purpose
get_people Get detailed information about specific people by their IDs
search_people Search for people by name (returns up to 25 results)
get_teams Get detailed information about specific teams by their IDs
search_teams Search for teams by name (returns up to 25 results)
get_teams_tags Get tags applied to specific teams
get_objectives Get objective details by their IDs
search_tags Search for tags by value (partial or exact match)
get_applied_tags Get all people or teams that have a specific tag applied

Example Queries You Can Ask Claude

  • "Show me all people in the Engineering team"
  • "What are the current objectives for the Product team?"
  • "Find all teams with 'marketing' in their name"
  • "Get details about person ID 12345 including their team memberships"
  • "Show me the tags applied to the Sales team"

Getting Help

Run teamform-mcp-server --help to see all available command line options.

Requirements

  • Node.js 22 or higher
  • Valid TeamForm API credentials
  • AI assistant that supports MCP (Claude Desktop or similar)

License

MIT

Package Sidebar

Install

npm i teamform-mcp-server

Weekly Downloads

0

Version

0.0.5

License

MIT

Unpacked Size

129 kB

Total Files

34

Last publish

Collaborators

  • orchestrated-admin