Companies House MCP Server

This project is a Model Context Protocol (MCP) server for interacting with the Companies House API. It provides tools for accessing company profiles, officers, and other related information.

Prerequisites

• Node.js (version 20 or later)
• pnpm
• A Companies House API key

Setup

1. Clone the repository:

   git clone <repository-url>
   cd <repository-directory>
   

2. Install dependencies:

   pnpm install
   

3. Set up environment variables: Create a .env file in the root directory and add your Companies House API key:

   COMPANIES_HOUSE_API_KEY=your_api_key_here
   

Running the Server

1. Start the MCP server:

   pnpm run dev
   

2. Access the server: The server will be running on http://localhost:8080 by default.

Endpoints

• SSE Endpoint: /sse

  • Used for server-sent events.

• Messages Endpoint: /messages

  • Used for handling post messages.

Tools

The server includes the following tools:

• Profile Tools: Access company profiles.
• Officers Tools: Access company officers.
• Search Tools: Search for companies.
• Companies House Tools: Access various Companies House services.

License

This project is licensed under the MIT License.