create-research-plan

Generate structured research plans for Web3 tokens by specifying token names and ticker symbols to organize crypto analysis.

Input Schema

TableJSON Schema

Name	Required	Description	Default
`tokenName`	Yes	Token name
`tokenTicker`	Yes	Token ticker symbol

Implementation Reference

src/tools/researchTools.ts:88-167 (handler)

The asynchronous handler function that executes the 'create-research-plan' tool logic. It logs the action, constructs a predefined research plan object with 11 sections (projectInfo, technicalFundamentals, marketStatus, listings, news, community, predictions, teamInfo, relatedCoins, socialSentiment) all set to 'planned' status, each with descriptions and sources, updates the 'researchPlan' section in storage, and returns a formatted text response containing the JSON-serialized plan.

  async ({
    tokenName,
    tokenTicker,
  }: {
    tokenName: string;
    tokenTicker: string;
  }) => {
    storage.addLogEntry(
      `Creating research plan for ${tokenName} (${tokenTicker})`
    );

    const researchPlan = {
      projectInfo: {
        description: "Gather basic information about the project",
        sources: ["Project website", "Documentation", "CoinMarketCap"],
        status: "planned" as const,
      },
      technicalFundamentals: {
        description: "Analyze the token's technical aspects",
        sources: ["Documentation", "GitHub", "IQ Wiki", "Token contract"],
        status: "planned" as const,
      },
      marketStatus: {
        description: "Evaluate current market performance",
        sources: ["CoinMarketCap", "TradingView", "GeckoTerminal"],
        status: "planned" as const,
      },
      listings: {
        description: "Find where the token is traded",
        sources: ["GeckoTerminal", "CoinMarketCap"],
        status: "planned" as const,
      },
      news: {
        description: "Gather recent news about the token",
        sources: ["Crypto news sites", "Twitter", "Medium"],
        status: "planned" as const,
      },
      community: {
        description: "Analyze the project's community",
        sources: ["Twitter", "Discord", "Telegram", "Reddit"],
        status: "planned" as const,
      },
      predictions: {
        description: "Collect price predictions and forecasts",
        sources: ["Analysis sites", "Expert opinions"],
        status: "planned" as const,
      },
      teamInfo: {
        description: "Research the team behind the project",
        sources: ["Project website", "LinkedIn", "Twitter"],
        status: "planned" as const,
      },
      relatedCoins: {
        description: "Identify tokens in the same category",
        sources: ["GeckoTerminal", "CoinMarketCap"],
        status: "planned" as const,
      },
      socialSentiment: {
        description: "Gauge social media sentiment",
        sources: ["Twitter", "Reddit", "Trading forums"],
        status: "planned" as const,
      },
    };

    storage.updateSection("researchPlan", researchPlan);

    return {
      content: [
        {
          type: "text",
          text: `Created research plan for ${tokenName} (${tokenTicker}):\n\n${JSON.stringify(
            researchPlan,
            null,
            2
          )}`,
        },
      ],
    };
  }
);

src/tools/researchTools.ts:84-87 (schema)
Zod input schema for the tool: requires 'tokenName' (string, described as 'Token name') and 'tokenTicker' (string, described as 'Token ticker symbol').
```
{
  tokenName: z.string().describe("Token name"),
  tokenTicker: z.string().describe("Token ticker symbol"),
},
```

src/tools/researchTools.ts:82-167 (registration)

Direct registration of the 'create-research-plan' tool using server.tool(name, schema, handler) within the registerResearchTools function.

server.tool(
  "create-research-plan",
  {
    tokenName: z.string().describe("Token name"),
    tokenTicker: z.string().describe("Token ticker symbol"),
  },
  async ({
    tokenName,
    tokenTicker,
  }: {
    tokenName: string;
    tokenTicker: string;
  }) => {
    storage.addLogEntry(
      `Creating research plan for ${tokenName} (${tokenTicker})`
    );

    const researchPlan = {
      projectInfo: {
        description: "Gather basic information about the project",
        sources: ["Project website", "Documentation", "CoinMarketCap"],
        status: "planned" as const,
      },
      technicalFundamentals: {
        description: "Analyze the token's technical aspects",
        sources: ["Documentation", "GitHub", "IQ Wiki", "Token contract"],
        status: "planned" as const,
      },
      marketStatus: {
        description: "Evaluate current market performance",
        sources: ["CoinMarketCap", "TradingView", "GeckoTerminal"],
        status: "planned" as const,
      },
      listings: {
        description: "Find where the token is traded",
        sources: ["GeckoTerminal", "CoinMarketCap"],
        status: "planned" as const,
      },
      news: {
        description: "Gather recent news about the token",
        sources: ["Crypto news sites", "Twitter", "Medium"],
        status: "planned" as const,
      },
      community: {
        description: "Analyze the project's community",
        sources: ["Twitter", "Discord", "Telegram", "Reddit"],
        status: "planned" as const,
      },
      predictions: {
        description: "Collect price predictions and forecasts",
        sources: ["Analysis sites", "Expert opinions"],
        status: "planned" as const,
      },
      teamInfo: {
        description: "Research the team behind the project",
        sources: ["Project website", "LinkedIn", "Twitter"],
        status: "planned" as const,
      },
      relatedCoins: {
        description: "Identify tokens in the same category",
        sources: ["GeckoTerminal", "CoinMarketCap"],
        status: "planned" as const,
      },
      socialSentiment: {
        description: "Gauge social media sentiment",
        sources: ["Twitter", "Reddit", "Trading forums"],
        status: "planned" as const,
      },
    };

    storage.updateSection("researchPlan", researchPlan);

    return {
      content: [
        {
          type: "text",
          text: `Created research plan for ${tokenName} (${tokenTicker}):\n\n${JSON.stringify(
            researchPlan,
            null,
            2
          )}`,
        },
      ],
    };
  }
);

src/tools/index.ts:5-10 (registration)
registerAllTools function that calls registerResearchTools(server, storage), thereby registering the create-research-plan tool among others.
```
export function registerAllTools(
  server: McpServer,
  storage: ResearchStorage
): void {
  registerResearchTools(server, storage);
}
```
src/server.ts:187-187 (registration)
Top-level invocation of registerAllTools(server, storage) in the main server file, which ultimately registers the create-research-plan tool.
```
registerAllTools(server, storage);
```

Web3 Research MCP