Documentation

Everything you need to get started with Routesy.

MCP Server

For licenses starting from the Senior tier, Routesy provides a built-in MCP server to make it easy for AI assistants to connect with Routesy in order to consume information related to your project in general, as well as send requests easily.

The MCP Server tab in Settings shows a status indicator confirming the server is available. It also includes a link to this documentation page for quick reference.

Here is a basic example of connecting Claude Code with the Routesy MCP server:

{
"mcpServers": {
"routesy": {
"command": "node",
"args": ["/path/to/routesy/mcp-server/dist/index.js"]
}
}
}

The MCP server reads data from Routesy's local SQLite database. The database is located at:

  • macOS: ~/Library/Application Support/com.routesy.app/routesy.db
  • Windows: %APPDATA%/com.routesy.app/routesy.db

Available Tools

list_routes

Lists all routes for a given project.

Parameter Type Required Description
project_path string Yes Path to the Laravel project
method string No Filter by HTTP method (GET, POST, etc.)
group_by string No Group routes by method or prefix

search_routes

Searches routes by URI or name.

Parameter Type Required Description
query string Yes Search term to match against route URIs and names
project_path string No Path to the Laravel project
method string No Filter by HTTP method

send_request

Sends an HTTP request to a route.

Parameter Type Required Description
method string Yes HTTP method (GET, POST, PUT, etc.)
uri string Yes The route URI
project_path string Yes Path to the Laravel project
parameters object No Route parameters
body object No Request body
query object No Query string parameters
headers object No Custom headers
environment string No Environment name to use

Note: Sanctum authentication is not available via the MCP Server, as it requires an active application window to manage cookies and session state. Use Bearer Token authentication instead when sending authenticated requests through the MCP Server.