Easychamp AI TypeScript MCP Server

It is generated with Stainless.

Installation

Direct invocation

You can run the MCP Server directly via npx:

export EASYCHAMP_AI_API_KEY="My API Key"
npx -y easychamp-ai-mcp@latest

Via MCP Client

There is a partial list of existing clients at modelcontextprotocol.io. If you already have a client, consult their documentation to install the MCP server.

For clients with a configuration JSON, it might look something like this:

{
  "mcpServers": {
    "easychamp_ai_api": {
      "command": "npx",
      "args": ["-y", "easychamp-ai-mcp", "--client=claude", "--tools=dynamic"],
      "env": {
        "EASYCHAMP_AI_API_KEY": "My API Key"
      }
    }
  }
}

Exposing endpoints to your MCP Client

There are two ways to expose endpoints as tools in the MCP server:

1. Exposing one tool per endpoint, and filtering as necessary
2. Exposing a set of tools to dynamically discover and invoke endpoints from the API

Filtering endpoints and tools

You can run the package on the command line to discover and filter the set of tools that are exposed by the MCP Server. This can be helpful for large APIs where including all endpoints at once is too much for your AI's context window.

You can filter by multiple aspects:

• --tool includes a specific tool by name
• --resource includes all tools under a specific resource, and can have wildcards, e.g. my.resource*
• --operation includes just read (get/list) or just write operations

Dynamic tools

If you specify --tools=dynamic to the MCP server, instead of exposing one tool per endpoint in the API, it will expose the following tools:

1. list_api_endpoints - Discovers available endpoints, with optional filtering by search query
2. get_api_endpoint_schema - Gets detailed schema information for a specific endpoint
3. invoke_api_endpoint - Executes any endpoint with the appropriate parameters

This allows you to have the full set of API endpoints available to your MCP Client, while not requiring that all of their schemas be loaded into context at once. Instead, the LLM will automatically use these tools together to search for, look up, and invoke endpoints dynamically. However, due to the indirect nature of the schemas, it can struggle to provide the correct properties a bit more than when tools are imported explicitly. Therefore, you can opt-in to explicit tools, the dynamic tools, or both.

See more information with --help.

All of these command-line options can be repeated, combined together, and have corresponding exclusion versions (e.g. --no-tool).

Use --list to see the list of available tools, or see below.

Specifying the MCP Client

Different clients have varying abilities to handle arbitrary tools and schemas.

You can specify the client you are using with the --client argument, and the MCP server will automatically serve tools and schemas that are more compatible with that client.

• --client=<type>: Set all capabilities based on a known MCP client

  • Valid values: openai-agents, claude, claude-code, cursor
  • Example: --client=cursor

Additionally, if you have a client not on the above list, or the client has gotten better over time, you can manually enable or disable certain capabilities:

• --capability=<name>: Specify individual client capabilities
  • Available capabilities:
    • top-level-unions: Enable support for top-level unions in tool schemas
    • valid-json: Enable JSON string parsing for arguments
    • refs: Enable support for $ref pointers in schemas
    • unions: Enable support for union types (anyOf) in schemas
    • formats: Enable support for format validations in schemas (e.g. date-time, email)
    • tool-name-length=N: Set maximum tool name length to N characters
  • Example: --capability=top-level-unions --capability=tool-name-length=40
  • Example: --capability=top-level-unions,tool-name-length=40

Examples

1. Filter for read operations on cards:

--resource=cards --operation=read

2. Exclude specific tools while including others:

--resource=cards --no-tool=create_cards

3. Configure for Cursor client with custom max tool name length:

--client=cursor --capability=tool-name-length=40

4. Complex filtering with multiple criteria:

--resource=cards,accounts --operation=read --tag=kyc --no-tool=create_cards

Importing the tools and server individually

// Import the server, generated endpoints, or the init function
import { server, endpoints, init } from "easychamp-ai-mcp/server";

// import a specific tool
import createAioptimizeChamps from "easychamp-ai-mcp/tools/aioptimize/champs/create-aioptimize-champs";

// initialize the server and all endpoints
init({ server, endpoints });

// manually start server
const transport = new StdioServerTransport();
await server.connect(transport);

// or initialize your own server with specific tools
const myServer = new McpServer(...);

// define your own endpoint
const myCustomEndpoint = {
  tool: {
    name: 'my_custom_tool',
    description: 'My custom tool',
    inputSchema: zodToJsonSchema(z.object({ a_property: z.string() })),
  },
  handler: async (client: client, args: any) => {
    return { myResponse: 'Hello world!' };
  })
};

// initialize the server with your custom endpoints
init({ server: myServer, endpoints: [createAioptimizeChamps, myCustomEndpoint] });

Available Tools

The following tools are available in this MCP server.

Resource aioptimize.champs:

• create_aioptimize_champs (write): This endpoint is part of the AI-optimized API designed for easy integration with AI assistants. It creates a new championship/competition with the specified name, league ID, and optional properties. The championship will be owned by the authenticated user making the request. The user must have update permission for the specified league. Sample request: POST /aioptimize/champs { "name": "Premier League 2023/2024", "leagueId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "startDate": "2023-08-01T00:00:00Z", "endDate": "2024-05-31T00:00:00Z", "isPublished": true, "description": "The 2023/2024 season of the English Premier League", "imageUrl": "https://example.com/premier-league-logo.png" }
• retrieve_aioptimize_champs (read): Retrieve a specific competition/tournament by its exact name. Use this to check if a competition already exists or to get details about an existing competition.
• update_aioptimize_champs (write): This operation is used to update competition/champ for the given name
• list_aioptimize_champs (read): Search for competitions/tournaments by various criteria. Returns a list of competitions matching the search parameters.
• delete_aioptimize_champs (write): This operation is used to delete the competition/champ for the given name
• add_stage_aioptimize_champs (write): This operation is used to add stage to the competition/champ with given name
• add_teams_aioptimize_champs (write): Add teams to an existing championship/competition. This tool allows you to add multiple teams to a championship by either creating new teams (using team names) or adding existing teams (using team IDs). Example: "Add teams Team1 and Team2 to June2Soc Cup"
• create_stage_aioptimize_champs (write): Create a stage (bracket) for a championship/competition. Use this to add tournament structures like round robin, playoff (knockout), or double elimination stages to an existing competition. Supported stage types: "round robin" or "league" (all teams play against each other), "playoff" or "knockout" or "single elimination" (elimination tournament), "double elimination" (tournament with winners and losers brackets). Example: "Generate round robin brackets with 2 rounds for June2Soc Cup"
• get_fixtures_aioptimize_champs (read): This operation is used to retrieve fixtures/matches for competition/champ with given name
• get_player_stats_aioptimize_champs (read): This operation is used to retrieve player stats for the given competition/champ name. This operation is still used to retrieve top, the best or the worst player(s) of the competition/champ.
• get_standings_aioptimize_champs (read): This operation is used to retrieve the standings(only standings) for competition/champ
• get_venues_aioptimize_champs (read): This operation is used to get list of venue objects of the competition/champ for the given competition/champ name
• handle_chat_aioptimize_champs (read): Handle natural language queries about championships
• recalculate_overall_player_stats_aioptimize_champs (write): This operation is used to recalculate total player stats for the specified competition/champ name
• recalculate_stage_player_stats_aioptimize_champs (write): This operation is used to recalculate stage player stats for the competition/champ

Resource aioptimize.champs.favorite:

• add_champs_aioptimize_favorite (write): This operation is used to add competition/champ with given name to favorites
• remove_champs_aioptimize_favorite (write): This operation is used to delete competiton/champ with given name from favorites

Resource aioptimize.champ_leagues:

• create_aioptimize_champ_leagues (write): Creates a new championship league with the provided details. Example request: { "name": "March5Test", "description": "A soccer league for testing", "sportKind": "Soccer" }
• retrieve_aioptimize_champ_leagues (read): Retrieve a specific league by its exact name. Use this to check if a league already exists before creating a new one or to get details about an existing league.
• update_aioptimize_champ_leagues (write): This operation is used to update champ league with given name
• list_aioptimize_champ_leagues (read): Search for leagues by various criteria. Returns a list of leagues matching the search parameters. Use this endpoint to find existing leagues before creating new ones.
• delete_aioptimize_champ_leagues (write): This operation is used to delete champ league with given name
• add_news_aioptimize_champ_leagues (write): This operation is used to add news to champ league with given name
• create_no_content_type_aioptimize_champ_leagues (write): Fallback API that creates a new championship league, specifically designed to work without Content-Type requirements. Use if the main endpoint fails.
• my_leagues_aioptimize_champ_leagues (read): Get leagues owned by the current user. Returns a list of leagues where the current user is the owner.
• recalculate_overall_player_stats_aioptimize_champ_leagues (write): This operation is used to recalculate overall/total player stats for champ league with given name
• recalculate_stage_player_stats_aioptimize_champ_leagues (write): This operation is used to recalculate stage player stats for champ league with given name
• retrieve_champs_aioptimize_champ_leagues (read): This operation is used to retrieve champs of champ league with given name
• retrieve_teams_aioptimize_champ_leagues (read): This operation is used to retrieve teams of champ league with given name
• search_aioptimize_champ_leagues (read): Search for a single league by name (partial or exact match). This is the preferred method to find a league before creating competitions under it. Example: GET /aioptimize/champ-leagues/search?name=March5Test

Resource aioptimize.champ_leagues.favorite:

• add_champ_leagues_aioptimize_favorite (write): This operation is used to add champ league with given name to favorites
• remove_champ_leagues_aioptimize_favorite (write): This operation is used to delete champ league with given name from favorites

Resource aioptimize.champ_leagues.user:

• leagues_champ_leagues_aioptimize_user (read): Retrieve all leagues associated with the authenticated user, with optional filtering by sport. This endpoint respects user-specific access controls.

Resource aioptimize.player:

• create_aioptimize_player (write): This endpoint is part of the AI-optimized API designed for easy integration with AI assistants. It creates a new player with the specified details and optional properties. The player will be owned by the authenticated user making the request.

  Sample request:

  POST /aioptimize/player
  {
     "firstName": "Cristiano",
     "lastName": "Ronaldo",
     "sportKind": "Football",
     "teamName": "Al Nassr",
     "position": "Forward",
     "jerseyNumber": 7,
     "nationality": "Portugal",
     "dateOfBirth": "1985-02-05T00:00:00Z",
     "imageUrl": "https://example.com/ronaldo.png"
  }

• retrieve_aioptimize_player (read): Retrieves details for the player with the specified name.

• update_aioptimize_player (write): Updates the information for the player with the specified name.

• delete_aioptimize_player (write): Deletes the player with the specified name.

• clone_aioptimize_player (write): Creates a new player by cloning an existing player with the specified name.

• retrieve_overall_stats_aioptimize_player (read): Retrieves overall statistical information for the player with the specified name.

• retrieve_stats_aioptimize_player (read): Retrieves statistical information be champs/stages/groups/leagues for the player with the specified name.

• search_aioptimize_player (read): Searches for players based on the specified criteria.

Resource aioptimize.player.favorite:

• add_player_aioptimize_favorite (write): Adds the player with the specified name to the user's favorites.
• remove_player_aioptimize_favorite (write): Removes the player with the specified name from the user's favorites.

Resource aioptimize.teams:

• create_aioptimize_teams (write): This endpoint is part of the AI-optimized API designed for easy integration with AI assistants. It creates a new team with the specified name, sport kind, and optional properties. The team will be owned by the authenticated user making the request.

  Sample request:

  POST /aioptimize/teams
  {
     "name": "Manchester United",
     "sportKind": "Football",
     "country": "England",
     "imageUrl": "https://example.com/mu-logo.png",
     "isInternational": false
  }

• retrieve_aioptimize_teams (read): Retrieves a team by its name.

• update_aioptimize_teams (write): Updates the information for an existing team with the specified name.

• delete_aioptimize_teams (write): Deletes a team with the specified name.

• add_player_aioptimize_teams (write): Creates a new player and associates them with the specified team.

• clone_aioptimize_teams (write): Creates a new team by cloning an existing team with the specified name.

• retrieve_players_aioptimize_teams (read): Retrieves the list of players belonging to the team with the specified name.

• retrieve_total_stats_aioptimize_teams (read): Retrieves total statistical information for the team with the specified name.

• search_aioptimize_teams (read): Retrieves teams based on the provided filters.

Resource aioptimize.teams.favorite:

• add_teams_aioptimize_favorite (write): Adds the team with the specified name to the user's favorites.
• remove_teams_aioptimize_favorite (write): Removes the team with the specified name from the user's favorites.

Resource aioptimize.stages:

• generate_fixtures_aioptimize_stages (write): Generate match fixtures (schedule) for an existing stage. This creates all the matches based on the stage configuration (groups, teams, rounds). Use this after creating a stage and adding teams to generate the match schedule. For identifying the stage: If stage ID is known, use it directly. If only championship name is known, first search for the championship to find its stages. If stage name/type is mentioned, find the matching stage (e.g., "generate fixtures for the group stage"). For active stages, look for stages with unplayed games. Example: "Generate fixtures for June2Soc Cup" would find the active stage and generate fixtures for it.